openapi: 3.0.3 info: version: 1.1.4 title: GitHub Application About Alerts API description: 'Use the REST API to retrieve information about GitHub Apps and GitHub App installations.' license: name: MIT url: https://spdx.org/licenses/MIT termsOfService: https://docs.github.com/articles/github-terms-of-service contact: name: Support url: https://support.github.com/contact?tags=dotcom-rest-api x-github-plan: ghes x-github-release: 3.9 servers: - url: '{protocol}://{hostname}/api/v3' variables: hostname: description: Self-hosted Enterprise Server hostname default: HOSTNAME protocol: description: Self-hosted Enterprise Server protocol default: http tags: - name: Alerts paths: /orgs/{org}/code-scanning/alerts: get: summary: GitHub List Code Scanning Alerts for an Organization description: 'Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." The authenticated user must be an owner or security manager for the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.' tags: - Alerts operationId: listCodeScanningAlertsForAnOrganization externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/tool-name' - $ref: '#/components/parameters/tool-guid' - $ref: '#/components/parameters/pagination-before' - $ref: '#/components/parameters/pagination-after' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/direction' - name: state description: If specified, only code scanning alerts with this state will be returned. in: query required: false schema: $ref: '#/components/schemas/code-scanning-alert-state-query' example: open - name: sort description: The property by which to sort the results. in: query required: false schema: type: string enum: - created - updated default: created example: created - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false schema: $ref: '#/components/schemas/code-scanning-alert-severity' example: example_value responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/code-scanning-organization-alert-items' examples: default: $ref: '#/components/examples/code-scanning-organization-alert-items' headers: Link: $ref: '#/components/headers/link' '404': $ref: '#/components/responses/not_found' '503': $ref: '#/components/responses/service_unavailable' x-github: githubCloudOnly: false enabledForGitHubApps: true category: code-scanning subcategory: code-scanning security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /orgs/{org}/dependabot/alerts: get: summary: GitHub List Dependabot Alerts for an Organization description: 'Lists Dependabot alerts for an organization. The authenticated user must be an owner or security manager for the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.' tags: - Alerts operationId: listDependabotAlertsForAnOrganization externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/dependabot-alert-comma-separated-states' - $ref: '#/components/parameters/dependabot-alert-comma-separated-severities' - $ref: '#/components/parameters/dependabot-alert-comma-separated-ecosystems' - $ref: '#/components/parameters/dependabot-alert-comma-separated-packages' - $ref: '#/components/parameters/dependabot-alert-scope' - $ref: '#/components/parameters/dependabot-alert-sort' - $ref: '#/components/parameters/direction' - $ref: '#/components/parameters/pagination-before' - $ref: '#/components/parameters/pagination-after' - $ref: '#/components/parameters/pagination-first' - $ref: '#/components/parameters/pagination-last' - $ref: '#/components/parameters/per-page' responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/dependabot-alert-with-repository' examples: default: $ref: '#/components/examples/dependabot-alerts-for-organization' '304': $ref: '#/components/responses/not_modified' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not_found' '422': $ref: '#/components/responses/validation_failed_simple' x-github: githubCloudOnly: false enabledForGitHubApps: true category: dependabot subcategory: alerts security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /orgs/{org}/secret-scanning/alerts: get: summary: GitHub List Secret Scanning Alerts for an Organization description: 'Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest. The authenticated user must be an administrator or security manager for the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.' tags: - Alerts operationId: listSecretScanningAlertsForAnOrganization externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/secret-scanning-alert-state' - $ref: '#/components/parameters/secret-scanning-alert-secret-type' - $ref: '#/components/parameters/secret-scanning-alert-resolution' - $ref: '#/components/parameters/secret-scanning-alert-sort' - $ref: '#/components/parameters/direction' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/secret-scanning-pagination-before-org-repo' - $ref: '#/components/parameters/secret-scanning-pagination-after-org-repo' responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/organization-secret-scanning-alert' examples: default: $ref: '#/components/examples/organization-secret-scanning-alert-list' headers: Link: $ref: '#/components/headers/link' '404': $ref: '#/components/responses/not_found' '503': $ref: '#/components/responses/service_unavailable' x-github: githubCloudOnly: false enabledForGitHubApps: true category: secret-scanning subcategory: secret-scanning security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}: get: summary: GitHub Get Code Scanning Alert description: 'Gets a single code scanning alert. OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.' tags: - Alerts operationId: getCodeScanningAlert externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/alert-number' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/code-scanning-alert' examples: default: $ref: '#/components/examples/code-scanning-alert' '304': $ref: '#/components/responses/not_modified' '403': $ref: '#/components/responses/code_scanning_forbidden_read' '404': $ref: '#/components/responses/not_found' '503': $ref: '#/components/responses/service_unavailable' x-github: githubCloudOnly: false enabledForGitHubApps: true category: code-scanning subcategory: code-scanning security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: GitHub Update Code Scanning Alert description: 'Updates the status of a single code scanning alert. OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.' operationId: updateCodeScanningAlert tags: - Alerts externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/alert-number' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value requestBody: required: true content: application/json: schema: type: object properties: state: $ref: '#/components/schemas/code-scanning-alert-set-state' dismissed_reason: $ref: '#/components/schemas/code-scanning-alert-dismissed-reason_2' dismissed_comment: $ref: '#/components/schemas/code-scanning-alert-dismissed-comment_2' required: - state examples: default: value: state: dismissed dismissed_reason: false positive dismissed_comment: This alert is not actually correct, because there's a sanitizer included in the library. responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/code-scanning-alert' examples: default: $ref: '#/components/examples/code-scanning-alert-dismissed' '403': $ref: '#/components/responses/code_scanning_forbidden_write' '404': $ref: '#/components/responses/not_found' '503': $ref: '#/components/responses/service_unavailable' x-github: enabledForGitHubApps: true githubCloudOnly: false category: code-scanning subcategory: code-scanning security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances: get: summary: GitHub List Instances of Code Scanning Alert description: 'Lists all instances of the specified code scanning alert. OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.' tags: - Alerts operationId: listInstancesOfCodeScanningAlert externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/alert-number' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/git-ref' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/code-scanning-alert-instance' examples: default: $ref: '#/components/examples/code-scanning-alert-instances' '403': $ref: '#/components/responses/code_scanning_forbidden_read' '404': $ref: '#/components/responses/not_found' '503': $ref: '#/components/responses/service_unavailable' x-github: githubCloudOnly: false enabledForGitHubApps: true category: code-scanning subcategory: code-scanning security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/dependabot/alerts: get: summary: GitHub List Dependabot Alerts for Repository description: OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. tags: - Alerts operationId: listDependabotAlertsForRepository externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/dependabot-alert-comma-separated-states_2' - $ref: '#/components/parameters/dependabot-alert-comma-separated-severities_2' - $ref: '#/components/parameters/dependabot-alert-comma-separated-ecosystems_2' - $ref: '#/components/parameters/dependabot-alert-comma-separated-packages_2' - $ref: '#/components/parameters/dependabot-alert-comma-separated-manifests' - $ref: '#/components/parameters/dependabot-alert-scope' - $ref: '#/components/parameters/dependabot-alert-sort' - $ref: '#/components/parameters/direction' - name: page description: '**Deprecated**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead.' deprecated: true in: query schema: type: integer default: 1 example: 42 - name: per_page description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." deprecated: true in: query schema: type: integer default: 30 example: 42 - $ref: '#/components/parameters/pagination-before_2' - $ref: '#/components/parameters/pagination-after_2' - $ref: '#/components/parameters/pagination-first' - $ref: '#/components/parameters/pagination-last' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/dependabot-alert' examples: default: $ref: '#/components/examples/dependabot-alerts-for-repository' '304': $ref: '#/components/responses/not_modified' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not_found' '422': $ref: '#/components/responses/validation_failed_simple' x-github: githubCloudOnly: false enabledForGitHubApps: true previews: [] category: dependabot subcategory: alerts x-api-evangelist-certified: '2025-07-16' x-api-naftiko-published: '2025-07-25' security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/dependabot/alerts/{alert_number}: get: summary: GitHub Get Dependabot Alert description: OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. tags: - Alerts operationId: getDependabotAlert externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/dependabot/alerts#get-a-dependabot-alert parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/dependabot-alert-number' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/dependabot-alert' examples: default: $ref: '#/components/examples/dependabot-alert-open' '304': $ref: '#/components/responses/not_modified' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: true previews: [] category: dependabot subcategory: alerts security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: GitHub Update Dependabot Alert description: 'The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.' tags: - Alerts operationId: updateDependabotAlert externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/dependabot/alerts#update-a-dependabot-alert parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/dependabot-alert-number' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value requestBody: required: true content: application/json: schema: type: object properties: state: type: string description: 'The state of the Dependabot alert. `dismissed_reason` must be provided when setting the state to `dismissed`.' enum: - dismissed - open dismissed_reason: type: string description: '**Required when `state` is `dismissed`.** reason for dismissing the alert.' enum: - fix_started - inaccurate - no_bandwidth - not_used - tolerable_risk dismissed_comment: type: string description: An optional comment associated with dismissing the alert. maxLength: 280 required: - state additionalProperties: false examples: default: value: state: dismissed dismissed_reason: tolerable_risk dismissed_comment: This alert is accurate but we use a sanitizer. responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/dependabot-alert' examples: default: $ref: '#/components/examples/dependabot-alert-dismissed' '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not_found' '409': $ref: '#/components/responses/conflict' '422': $ref: '#/components/responses/validation_failed_simple' x-github: githubCloudOnly: false enabledForGitHubApps: true previews: [] category: dependabot subcategory: alerts security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/secret-scanning/alerts: get: summary: GitHub List Secret Scanning Alerts for Repository description: 'Lists secret scanning alerts for an eligible repository, from newest to oldest. The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.' tags: - Alerts operationId: listSecretScanningAlertsForRepository externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/secret-scanning-alert-state' - $ref: '#/components/parameters/secret-scanning-alert-secret-type_2' - $ref: '#/components/parameters/secret-scanning-alert-resolution_2' - $ref: '#/components/parameters/secret-scanning-alert-sort' - $ref: '#/components/parameters/direction' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/secret-scanning-pagination-before-org-repo_2' - $ref: '#/components/parameters/secret-scanning-pagination-after-org-repo_2' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/secret-scanning-alert' examples: default: $ref: '#/components/examples/secret-scanning-alert-list' '404': description: Repository is public or secret scanning is disabled for the repository '503': $ref: '#/components/responses/service_unavailable' x-github: githubCloudOnly: false enabledForGitHubApps: true category: secret-scanning subcategory: secret-scanning x-api-evangelist-certified: '2025-07-16' x-api-naftiko-published: '2025-07-25' security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}: get: summary: GitHub Get Secret Scanning Alert description: 'Gets a single secret scanning alert detected in an eligible repository. The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.' tags: - Alerts operationId: getSecretScanningAlert externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/alert-number' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/secret-scanning-alert' examples: default: $ref: '#/components/examples/secret-scanning-alert-open' '304': $ref: '#/components/responses/not_modified' '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found '503': $ref: '#/components/responses/service_unavailable' x-github: githubCloudOnly: false enabledForGitHubApps: true category: secret-scanning subcategory: secret-scanning security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: GitHub Update Secret Scanning Alert description: 'Updates the status of a secret scanning alert in an eligible repository. The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.' operationId: updateSecretScanningAlert tags: - Alerts externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/alert-number' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value requestBody: required: true content: application/json: schema: type: object properties: state: $ref: '#/components/schemas/secret-scanning-alert-state' resolution: $ref: '#/components/schemas/secret-scanning-alert-resolution_2' resolution_comment: $ref: '#/components/schemas/secret-scanning-alert-resolution-comment' required: - state examples: default: value: state: resolved resolution: false_positive responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/secret-scanning-alert' examples: default: $ref: '#/components/examples/secret-scanning-alert-resolved' '400': description: Bad request, resolution comment is invalid or the resolution was not changed. '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found '422': description: State does not match the resolution or resolution comment '503': $ref: '#/components/responses/service_unavailable' x-github: enabledForGitHubApps: true githubCloudOnly: false category: secret-scanning subcategory: secret-scanning security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations: get: summary: GitHub List Locations for Secret Scanning Alert description: 'Lists all locations for a given secret scanning alert for an eligible repository. The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.' tags: - Alerts operationId: listLocationsForSecretScanningAlert externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/alert-number' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/per-page' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: type: array description: List of locations where the secret was detected items: $ref: '#/components/schemas/secret-scanning-location' examples: default: $ref: '#/components/examples/secret-scanning-location-list' headers: Link: $ref: '#/components/headers/link' '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found '503': $ref: '#/components/responses/service_unavailable' x-github: githubCloudOnly: false enabledForGitHubApps: true category: secret-scanning subcategory: secret-scanning security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/vulnerability-alerts: get: summary: GitHub Check if Vulnerability Alerts Are Enabled for Repository description: Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.9/articles/about-security-alerts-for-vulnerable-dependencies)". tags: - Alerts operationId: checkIfVulnerabilityAlertsAreEnabledForRepository externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '204': description: Response if repository is enabled with vulnerability alerts '404': description: Not Found if repository is not enabled with vulnerability alerts x-github: githubCloudOnly: false enabledForGitHubApps: false category: repos subcategory: repos security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK put: summary: GitHub Enable Vulnerability Alerts description: Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.9/articles/about-security-alerts-for-vulnerable-dependencies)". tags: - Alerts operationId: enableVulnerabilityAlerts externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/repos/repos#enable-vulnerability-alerts parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: repos security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: GitHub Disable Vulnerability Alerts description: 'Disables dependency alerts for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.9/articles/about-security-alerts-for-vulnerable-dependencies)".' tags: - Alerts operationId: disableVulnerabilityAlerts externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/repos/repos#disable-vulnerability-alerts parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: repos security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK components: schemas: nullable-simple-user: title: Simple User description: A GitHub user. type: object properties: name: nullable: true type: string example: octocat email: nullable: true type: string example: octocat@github.com login: type: string example: octocat id: type: integer example: 1 node_id: type: string example: MDQ6VXNlcjE= avatar_url: type: string format: uri example: https://github.com/images/error/octocat_happy.gif gravatar_id: type: string example: 41d064eb2195891e12d0413f63227ea7 nullable: true url: type: string format: uri example: https://api.github.com/users/octocat html_url: type: string format: uri example: https://github.com/octocat followers_url: type: string format: uri example: https://api.github.com/users/octocat/followers following_url: type: string example: https://api.github.com/users/octocat/following{/other_user} gists_url: type: string example: https://api.github.com/users/octocat/gists{/gist_id} starred_url: type: string example: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: type: string format: uri example: https://api.github.com/users/octocat/subscriptions organizations_url: type: string format: uri example: https://api.github.com/users/octocat/orgs repos_url: type: string format: uri example: https://api.github.com/users/octocat/repos events_url: type: string example: https://api.github.com/users/octocat/events{/privacy} received_events_url: type: string format: uri example: https://api.github.com/users/octocat/received_events type: type: string example: User site_admin: type: boolean example: true starred_at: type: string example: '"2020-07-09T00:17:55Z"' required: - avatar_url - events_url - followers_url - following_url - gists_url - gravatar_id - html_url - id - node_id - login - organizations_url - received_events_url - repos_url - site_admin - starred_url - subscriptions_url - type - url nullable: true alert-html-url: type: string description: The GitHub URL of the alert resource. format: uri readOnly: true code-scanning-analysis-tool-version: nullable: true type: string description: The version of the tool used to generate the code scanning analysis. alert-updated-at: type: string description: 'The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true alert-fixed-at: type: string description: 'The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true dependabot-alert-security-advisory: type: object description: Details for the GitHub Security Advisory. readOnly: true properties: ghsa_id: type: string description: The unique GitHub Security Advisory ID assigned to the advisory. readOnly: true example: '12345678' cve_id: type: string description: The unique CVE ID assigned to the advisory. readOnly: true nullable: true example: '12345678' summary: type: string description: A short, plain text summary of the advisory. readOnly: true maxLength: 1024 example: example_value description: type: string description: A long-form Markdown-supported description of the advisory. readOnly: true example: This is an example repository vulnerabilities: type: array description: Vulnerable version range information for the advisory. readOnly: true items: $ref: '#/components/schemas/dependabot-alert-security-vulnerability' severity: type: string description: The severity of the advisory. readOnly: true enum: - low - medium - high - critical example: low cvss: type: object description: Details for the advisory pertaining to the Common Vulnerability Scoring System. readOnly: true properties: score: type: number description: The overall CVSS score of the advisory. minimum: 0 maximum: 10 readOnly: true vector_string: type: string description: The full CVSS vector string for the advisory. readOnly: true nullable: true required: - score - vector_string additionalProperties: false cwes: type: array description: Details for the advisory pertaining to Common Weakness Enumeration. readOnly: true items: type: object description: A CWE weakness assigned to the advisory. readOnly: true properties: cwe_id: type: string description: The unique CWE ID. readOnly: true name: type: string description: The short, plain text name of the CWE. readOnly: true required: - cwe_id - name additionalProperties: false identifiers: type: array description: Values that identify this advisory among security information sources. readOnly: true items: type: object description: An advisory identifier. readOnly: true properties: type: type: string description: The type of advisory identifier. readOnly: true enum: - CVE - GHSA value: type: string description: The value of the advisory identifer. readOnly: true required: - value - type additionalProperties: false references: type: array description: Links to additional advisory information. readOnly: true items: type: object description: A link to additional advisory information. readOnly: true properties: url: type: string description: The URL of the reference. format: uri readOnly: true required: - url additionalProperties: false published_at: type: string description: 'The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true example: '2026-04-17T12:00:00Z' updated_at: type: string description: 'The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true example: '2026-04-17T12:00:00Z' withdrawn_at: type: string description: 'The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true example: '2026-04-17T12:00:00Z' required: - ghsa_id - cve_id - summary - description - vulnerabilities - severity - cvss - cwes - identifiers - references - published_at - updated_at - withdrawn_at additionalProperties: false secret-scanning-alert-state: description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved secret-scanning-location: type: object properties: type: type: string enum: - commit - issue_title - issue_body - issue_comment - discussion_title - discussion_body - discussion_comment - pull_request_title - pull_request_body - pull_request_comment - pull_request_review - pull_request_review_comment description: The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found. example: commit details: oneOf: - $ref: '#/components/schemas/secret-scanning-location-commit' - $ref: '#/components/schemas/secret-scanning-location-issue-title' - $ref: '#/components/schemas/secret-scanning-location-issue-body' - $ref: '#/components/schemas/secret-scanning-location-issue-comment' - $ref: '#/components/schemas/secret-scanning-location-discussion-title' - $ref: '#/components/schemas/secret-scanning-location-discussion-body' - $ref: '#/components/schemas/secret-scanning-location-discussion-comment' - $ref: '#/components/schemas/secret-scanning-location-pull-request-title' - $ref: '#/components/schemas/secret-scanning-location-pull-request-body' - $ref: '#/components/schemas/secret-scanning-location-pull-request-comment' - $ref: '#/components/schemas/secret-scanning-location-pull-request-review' - $ref: '#/components/schemas/secret-scanning-location-pull-request-review-comment' example: example_value required: - type - details alert-auto-dismissed-at: type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true dependabot-alert: type: object description: Dependabot alert. properties: number: $ref: '#/components/schemas/alert-number' state: type: string description: The state of the Dependabot alert. readOnly: true enum: - auto_dismissed - dismissed - fixed - open example: auto_dismissed dependency: type: object description: Details for the vulnerable dependency. readOnly: true properties: package: $ref: '#/components/schemas/dependabot-alert-package' manifest_path: type: string description: The full path to the dependency manifest file, relative to the root of the repository. readOnly: true scope: type: string description: The execution scope of the vulnerable dependency. readOnly: true enum: - development - runtime security_advisory: $ref: '#/components/schemas/dependabot-alert-security-advisory_2' security_vulnerability: $ref: '#/components/schemas/dependabot-alert-security-vulnerability_2' 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_3' dismissed_by: $ref: '#/components/schemas/nullable-simple-user_3' dismissed_reason: type: string description: The reason that the alert was dismissed. enum: - fix_started - inaccurate - no_bandwidth - not_used - tolerable_risk example: fix_started dismissed_comment: type: string description: An optional comment associated with the alert's dismissal. maxLength: 280 example: example_value fixed_at: $ref: '#/components/schemas/alert-fixed-at_3' auto_dismissed_at: $ref: '#/components/schemas/alert-auto-dismissed-at_2' 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-dismissed-at_3: type: string description: 'The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true simple-repository: title: Simple Repository description: A GitHub repository. type: object properties: id: type: integer example: 1296269 description: A unique identifier of the repository. node_id: type: string example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 description: The GraphQL identifier of the repository. name: type: string example: Hello-World description: The name of the repository. full_name: type: string example: octocat/Hello-World description: The full, globally unique, name of the repository. owner: $ref: '#/components/schemas/simple-user' private: type: boolean description: Whether the repository is private. example: true html_url: type: string format: uri example: https://github.com/octocat/Hello-World description: The URL to view the repository on GitHub.com. description: type: string example: This your first repo! nullable: true description: The repository description. fork: type: boolean description: Whether the repository is a fork. example: true url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World description: The URL to get more information about the repository from the GitHub API. archive_url: type: string example: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} description: A template for the API URL to download the repository as an archive. assignees_url: type: string example: https://api.github.com/repos/octocat/Hello-World/assignees{/user} description: A template for the API URL to list the available assignees for issues in the repository. blobs_url: type: string example: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} description: A template for the API URL to create or retrieve a raw Git blob in the repository. branches_url: type: string example: https://api.github.com/repos/octocat/Hello-World/branches{/branch} description: A template for the API URL to get information about branches in the repository. collaborators_url: type: string example: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} description: A template for the API URL to get information about collaborators of the repository. comments_url: type: string example: https://api.github.com/repos/octocat/Hello-World/comments{/number} description: A template for the API URL to get information about comments on the repository. commits_url: type: string example: https://api.github.com/repos/octocat/Hello-World/commits{/sha} description: A template for the API URL to get information about commits on the repository. compare_url: type: string example: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} description: A template for the API URL to compare two commits or refs. contents_url: type: string example: https://api.github.com/repos/octocat/Hello-World/contents/{+path} description: A template for the API URL to get the contents of the repository. contributors_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/contributors description: A template for the API URL to list the contributors to the repository. deployments_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/deployments description: The API URL to list the deployments of the repository. downloads_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/downloads description: The API URL to list the downloads on the repository. events_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/events description: The API URL to list the events of the repository. forks_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/forks description: The API URL to list the forks of the repository. git_commits_url: type: string example: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} description: A template for the API URL to get information about Git commits of the repository. git_refs_url: type: string example: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} description: A template for the API URL to get information about Git refs of the repository. git_tags_url: type: string example: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} description: A template for the API URL to get information about Git tags of the repository. issue_comment_url: type: string example: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} description: A template for the API URL to get information about issue comments on the repository. issue_events_url: type: string example: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} description: A template for the API URL to get information about issue events on the repository. issues_url: type: string example: https://api.github.com/repos/octocat/Hello-World/issues{/number} description: A template for the API URL to get information about issues on the repository. keys_url: type: string example: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} description: A template for the API URL to get information about deploy keys on the repository. labels_url: type: string example: https://api.github.com/repos/octocat/Hello-World/labels{/name} description: A template for the API URL to get information about labels of the repository. languages_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/languages description: The API URL to get information about the languages of the repository. merges_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/merges description: The API URL to merge branches in the repository. milestones_url: type: string example: https://api.github.com/repos/octocat/Hello-World/milestones{/number} description: A template for the API URL to get information about milestones of the repository. notifications_url: type: string example: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} description: A template for the API URL to get information about notifications on the repository. pulls_url: type: string example: https://api.github.com/repos/octocat/Hello-World/pulls{/number} description: A template for the API URL to get information about pull requests on the repository. releases_url: type: string example: https://api.github.com/repos/octocat/Hello-World/releases{/id} description: A template for the API URL to get information about releases on the repository. stargazers_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/stargazers description: The API URL to list the stargazers on the repository. statuses_url: type: string example: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} description: A template for the API URL to get information about statuses of a commit. subscribers_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/subscribers description: The API URL to list the subscribers on the repository. subscription_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/subscription description: The API URL to subscribe to notifications for this repository. tags_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/tags description: The API URL to get information about tags on the repository. teams_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/teams description: The API URL to list the teams on the repository. trees_url: type: string example: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} description: A template for the API URL to create or retrieve a raw Git tree of the repository. hooks_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks description: The API URL to list the hooks on the 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 dependabot-alert-package: type: object description: Details for the vulnerable package. readOnly: true properties: ecosystem: type: string description: The package's language or package management ecosystem. readOnly: true example: example_value name: type: string description: The unique package name within its ecosystem. readOnly: true example: octocat required: - ecosystem - name additionalProperties: false code-scanning-analysis-category: type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code. code-scanning-analysis-tool: type: object properties: name: $ref: '#/components/schemas/code-scanning-analysis-tool-name' version: $ref: '#/components/schemas/code-scanning-analysis-tool-version' guid: $ref: '#/components/schemas/code-scanning-analysis-tool-guid' secret-scanning-location-discussion-title: description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. type: object properties: discussion_title_url: type: string format: uri description: The URL to the discussion where the secret was detected. example: https://github.com/community/community/discussions/39082 required: - discussion_title_url nullable-alert-updated-at: type: string description: 'The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true code-scanning-alert-environment: type: string description: Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. code-scanning-analysis-analysis-key: type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. code-scanning-alert-rule: type: object properties: id: type: string description: unique identifier for the rule used to detect the alert. example: '12345678' name: type: string description: The name of the rule used to detect the alert. example: octocat severity: type: string description: The severity of the alert. enum: - none - note - warning - error example: none security_severity_level: type: string description: The security severity of the alert. enum: - low - medium - high - critical example: low description: type: string description: short description of the rule used to detect the alert. example: This is an example repository full_description: type: string description: description of the rule used to detect the alert. example: This is an example repository tags: type: array description: set of tags applicable for the rule. items: type: string help: type: string description: Detailed documentation for the rule as GitHub Flavored Markdown. example: example_value help_uri: type: string description: link to the documentation for the rule used to detect the alert. example: example_value nullable-simple-user_3: title: Simple User description: GitHub user. type: object properties: name: type: string example: octocat email: type: string example: octocat@github.com login: type: string example: octocat id: type: integer format: int64 example: 1 node_id: type: string example: MDQ6VXNlcjE= avatar_url: type: string format: uri example: https://github.com/images/error/octocat_happy.gif gravatar_id: type: string example: 41d064eb2195891e12d0413f63227ea7 url: type: string format: uri example: https://api.github.com/users/octocat html_url: type: string format: uri example: https://github.com/octocat followers_url: type: string format: uri example: https://api.github.com/users/octocat/followers following_url: type: string example: https://api.github.com/users/octocat/following{/other_user} gists_url: type: string example: https://api.github.com/users/octocat/gists{/gist_id} starred_url: type: string example: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: type: string format: uri example: https://api.github.com/users/octocat/subscriptions organizations_url: type: string format: uri example: https://api.github.com/users/octocat/orgs repos_url: type: string format: uri example: https://api.github.com/users/octocat/repos events_url: type: string example: https://api.github.com/users/octocat/events{/privacy} received_events_url: type: string format: uri example: https://api.github.com/users/octocat/received_events type: type: string example: User site_admin: type: boolean example: true starred_at: type: string example: '"2020-07-09T00:17:55Z"' required: - avatar_url - events_url - followers_url - following_url - gists_url - gravatar_id - html_url - id - node_id - login - organizations_url - received_events_url - repos_url - site_admin - starred_url - subscriptions_url - type - url nullable-simple-user_2: title: Simple User description: GitHub user. type: object properties: name: type: string example: octocat email: type: string example: octocat@github.com login: type: string example: octocat id: type: integer format: int64 example: 1 node_id: type: string example: MDQ6VXNlcjE= avatar_url: type: string format: uri example: https://github.com/images/error/octocat_happy.gif gravatar_id: type: string example: 41d064eb2195891e12d0413f63227ea7 url: type: string format: uri example: https://api.github.com/users/octocat html_url: type: string format: uri example: https://github.com/octocat followers_url: type: string format: uri example: https://api.github.com/users/octocat/followers following_url: type: string example: https://api.github.com/users/octocat/following{/other_user} gists_url: type: string example: https://api.github.com/users/octocat/gists{/gist_id} starred_url: type: string example: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: type: string format: uri example: https://api.github.com/users/octocat/subscriptions organizations_url: type: string format: uri example: https://api.github.com/users/octocat/orgs repos_url: type: string format: uri example: https://api.github.com/users/octocat/repos events_url: type: string example: https://api.github.com/users/octocat/events{/privacy} received_events_url: type: string format: uri example: https://api.github.com/users/octocat/received_events type: type: string example: User site_admin: type: boolean example: true starred_at: type: string example: '"2020-07-09T00:17:55Z"' required: - avatar_url - events_url - followers_url - following_url - gists_url - gravatar_id - html_url - id - node_id - login - organizations_url - received_events_url - repos_url - site_admin - starred_url - subscriptions_url - type - url basic-error: title: Basic Error description: Basic Error type: object properties: message: type: string example: Example body text documentation_url: type: string example: https://api.github.com/repos/octocat/Hello-World url: type: string example: https://api.github.com/repos/octocat/Hello-World status: type: string example: open nullable-alert-updated-at_2: 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 dependabot-alert-security-advisory_2: type: object description: Details for the GitHub Security Advisory. readOnly: true properties: ghsa_id: type: string description: The unique GitHub Security Advisory ID assigned to the advisory. readOnly: true example: '12345678' cve_id: type: string description: The unique CVE ID assigned to the advisory. readOnly: true example: '12345678' summary: type: string description: short, plain text summary of the advisory. readOnly: true maxLength: 1024 example: example_value description: type: string description: long-form Markdown-supported description of the advisory. readOnly: true example: This is an example repository vulnerabilities: type: array description: Vulnerable version range information for the advisory. readOnly: true items: $ref: '#/components/schemas/dependabot-alert-security-vulnerability_2' severity: type: string description: The severity of the advisory. readOnly: true enum: - low - medium - high - critical example: low cvss: type: object description: Details for the advisory pertaining to the Common Vulnerability Scoring System. readOnly: true properties: score: type: number description: The overall CVSS score of the advisory. minimum: 0 maximum: 10 readOnly: true vector_string: type: string description: The full CVSS vector string for the advisory. readOnly: true required: - score - vector_string additionalProperties: false cwes: type: array description: Details for the advisory pertaining to Common Weakness Enumeration. readOnly: true items: type: object description: CWE weakness assigned to the advisory. readOnly: true properties: cwe_id: type: string description: The unique CWE ID. readOnly: true name: type: string description: The short, plain text name of the CWE. readOnly: true required: - cwe_id - name additionalProperties: false identifiers: type: array description: Values that identify this advisory among security information sources. readOnly: true items: type: object description: An advisory identifier. readOnly: true properties: type: type: string description: The type of advisory identifier. readOnly: true enum: - CVE - GHSA value: type: string description: The value of the advisory identifer. readOnly: true required: - value - type additionalProperties: false references: type: array description: Links to additional advisory information. readOnly: true items: type: object description: link to additional advisory information. readOnly: true properties: url: type: string description: The URL of the reference. format: uri readOnly: true required: - url additionalProperties: false published_at: type: string description: 'The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true example: '2026-04-17T12:00:00Z' updated_at: type: string description: 'The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true example: '2026-04-17T12:00:00Z' withdrawn_at: type: string description: 'The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true example: '2026-04-17T12:00:00Z' required: - ghsa_id - cve_id - summary - description - vulnerabilities - severity - cvss - cwes - identifiers - references - published_at - updated_at - withdrawn_at additionalProperties: false secret-scanning-location-issue-comment: description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. type: object properties: issue_comment_url: type: string format: uri description: The API URL to get the issue comment where the secret was detected. example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - issue_comment_url secret-scanning-location-discussion-body: description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. type: object properties: discussion_body_url: type: string format: uri description: The URL to the discussion where the secret was detected. example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url secret-scanning-location-pull-request-comment: description: Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. type: object properties: pull_request_comment_url: type: string format: uri description: The API URL to get the pull request comment where the secret was detected. example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - pull_request_comment_url scim-error: title: Scim Error description: Scim Error type: object properties: message: type: string nullable: true example: Example body text documentation_url: type: string nullable: true example: https://api.github.com/repos/octocat/Hello-World detail: type: string nullable: true example: example_value status: type: integer example: 42 scimType: type: string nullable: true example: User schemas: type: array items: type: string dependabot-alert-security-vulnerability_2: type: object description: Details pertaining to one vulnerable version range for the advisory. readOnly: true properties: package: $ref: '#/components/schemas/dependabot-alert-package' severity: type: string description: The severity of the vulnerability. readOnly: true enum: - low - medium - high - critical example: low vulnerable_version_range: type: string description: Conditions that identify vulnerable versions of this vulnerability's package. readOnly: true example: example_value first_patched_version: type: object description: Details pertaining to the package version that patches this vulnerability. readOnly: true properties: identifier: type: string description: The package version that patches this vulnerability. readOnly: true required: - identifier additionalProperties: false required: - package - severity - vulnerable_version_range - first_patched_version additionalProperties: false secret-scanning-alert-resolution: type: string description: '**Required when the `state` is `resolved`.** The reason for resolving the alert.' nullable: true enum: - false_positive - wont_fix - revoked - used_in_tests alert-fixed-at_2: type: string description: 'The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true code-scanning-organization-alert-items: type: object properties: number: $ref: '#/components/schemas/alert-number' created_at: $ref: '#/components/schemas/alert-created-at' updated_at: $ref: '#/components/schemas/alert-updated-at' url: $ref: '#/components/schemas/alert-url' html_url: $ref: '#/components/schemas/alert-html-url' instances_url: $ref: '#/components/schemas/alert-instances-url' state: $ref: '#/components/schemas/code-scanning-alert-state' fixed_at: $ref: '#/components/schemas/alert-fixed-at' dismissed_by: $ref: '#/components/schemas/nullable-simple-user' dismissed_at: $ref: '#/components/schemas/alert-dismissed-at' dismissed_reason: $ref: '#/components/schemas/code-scanning-alert-dismissed-reason' dismissed_comment: $ref: '#/components/schemas/code-scanning-alert-dismissed-comment' rule: $ref: '#/components/schemas/code-scanning-alert-rule-summary' tool: $ref: '#/components/schemas/code-scanning-analysis-tool' most_recent_instance: $ref: '#/components/schemas/code-scanning-alert-instance' repository: $ref: '#/components/schemas/simple-repository' required: - number - created_at - url - html_url - instances_url - state - dismissed_by - dismissed_at - dismissed_reason - rule - tool - most_recent_instance - repository code-scanning-analysis-tool-guid: nullable: true type: string description: The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. code-scanning-alert-rule-summary: type: object properties: id: nullable: true type: string description: A unique identifier for the rule used to detect the alert. example: '12345678' name: type: string description: The name of the rule used to detect the alert. example: octocat tags: nullable: true type: array description: A set of tags applicable for the rule. items: type: string severity: nullable: true type: string description: The severity of the alert. enum: - none - note - warning - error example: none security_severity_level: nullable: true type: string description: The security severity of the alert. enum: - low - medium - high - critical example: low description: type: string description: A short description of the rule used to detect the alert. example: This is an example repository code-scanning-alert-instance: type: object properties: ref: $ref: '#/components/schemas/code-scanning-ref' analysis_key: $ref: '#/components/schemas/code-scanning-analysis-analysis-key' environment: $ref: '#/components/schemas/code-scanning-alert-environment' category: $ref: '#/components/schemas/code-scanning-analysis-category' state: $ref: '#/components/schemas/code-scanning-alert-state' commit_sha: type: string example: abc123def456789012345678901234567890 message: type: object properties: text: type: string location: $ref: '#/components/schemas/code-scanning-alert-location' html_url: type: string example: https://api.github.com/repos/octocat/Hello-World classifications: type: array description: 'Classifications that have been applied to the file that triggered the alert. For example identifying it as documentation, or a generated file.' items: $ref: '#/components/schemas/code-scanning-alert-classification' secret-scanning-location-pull-request-review: description: Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. type: object properties: pull_request_review_url: type: string format: uri description: The API URL to get the pull request review where the secret was detected. example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 required: - pull_request_review_url code-scanning-alert-classification: type: string description: A classification of the file. For example to identify it as generated. nullable: true enum: - source - generated - test - library code-scanning-alert-severity: type: string description: Severity of a code scanning alert. enum: - critical - high - medium - low - warning - note - error secret-scanning-location-pull-request-body: description: Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. type: object properties: pull_request_body_url: type: string format: uri description: The API URL to get the pull request where the secret was detected. example: https://api.github.com/repos/octocat/Hello-World/pull/2846 required: - pull_request_body_url secret-scanning-alert: type: object properties: number: $ref: '#/components/schemas/alert-number' created_at: $ref: '#/components/schemas/alert-created-at' updated_at: $ref: '#/components/schemas/nullable-alert-updated-at_2' url: $ref: '#/components/schemas/alert-url' html_url: $ref: '#/components/schemas/alert-html-url' locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. example: https://api.github.com/repos/octocat/Hello-World state: $ref: '#/components/schemas/secret-scanning-alert-state' resolution: $ref: '#/components/schemas/secret-scanning-alert-resolution_2' resolved_at: type: string format: date-time description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' example: '2026-04-17T12:00:00Z' resolved_by: $ref: '#/components/schemas/nullable-simple-user_4' resolution_comment: type: string description: An optional comment to resolve an alert. example: example_value secret_type: type: string description: The type of secret that secret scanning detected. example: User secret_type_display_name: type: string description: 'User-friendly name for the detected secret, matching the `secret_type`. For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)."' example: octocat secret: type: string description: The secret that was detected. example: example_value push_protection_bypassed: type: boolean description: Whether push protection was bypassed for the detected secret. example: true push_protection_bypassed_by: $ref: '#/components/schemas/nullable-simple-user_4' push_protection_bypassed_at: type: string format: date-time description: 'The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' example: '2026-04-17T12:00:00Z' alert-dismissed-at: type: string description: 'The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true code-scanning-analysis-tool-name: type: string description: The name of the tool used to generate the code scanning analysis. secret-scanning-location-pull-request-title: description: Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. type: object properties: pull_request_title_url: type: string format: uri description: The API URL to get the pull request where the secret was detected. example: https://api.github.com/repos/octocat/Hello-World/pull/2846 required: - pull_request_title_url validation-error-simple: title: Validation Error Simple description: Validation Error Simple type: object required: - message - documentation_url properties: message: type: string example: Example body text documentation_url: type: string example: https://api.github.com/repos/octocat/Hello-World errors: type: array items: type: string secret-scanning-alert-resolution-comment: description: An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`. type: string secret-scanning-location-discussion-comment: description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. type: object properties: discussion_comment_url: type: string format: uri description: The API URL to get the discussion comment where the secret was detected. example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url secret-scanning-location-commit: description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. type: object properties: path: type: string description: The file path in the repository example: /example/secrets.txt start_line: type: number description: Line number at which the secret starts in the file example: 42.5 end_line: type: number description: Line number at which the secret ends in the file example: 42.5 start_column: type: number description: The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII example: 42.5 end_column: type: number description: The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII example: 42.5 blob_sha: type: string description: SHA-1 hash ID of the associated blob example: af5626b4a114abcb82d63db7c8082c3c4756e51b blob_url: type: string description: The API URL to get the associated blob resource example: https://api.github.com/repos/octocat/Hello-World commit_sha: type: string description: SHA-1 hash ID of the associated commit example: af5626b4a114abcb82d63db7c8082c3c4756e51b commit_url: type: string description: The API URL to get the associated commit resource example: https://api.github.com/repos/octocat/Hello-World required: - path - start_line - end_line - start_column - end_column - blob_sha - blob_url - commit_sha - commit_url nullable-simple-user_4: title: Simple User description: GitHub user. type: object properties: name: type: string example: octocat email: type: string example: octocat@github.com login: type: string example: octocat id: type: integer format: int64 example: 1 node_id: type: string example: MDQ6VXNlcjE= avatar_url: type: string format: uri example: https://github.com/images/error/octocat_happy.gif gravatar_id: type: string example: 41d064eb2195891e12d0413f63227ea7 url: type: string format: uri example: https://api.github.com/users/octocat html_url: type: string format: uri example: https://github.com/octocat followers_url: type: string format: uri example: https://api.github.com/users/octocat/followers following_url: type: string example: https://api.github.com/users/octocat/following{/other_user} gists_url: type: string example: https://api.github.com/users/octocat/gists{/gist_id} starred_url: type: string example: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: type: string format: uri example: https://api.github.com/users/octocat/subscriptions organizations_url: type: string format: uri example: https://api.github.com/users/octocat/orgs repos_url: type: string format: uri example: https://api.github.com/users/octocat/repos events_url: type: string example: https://api.github.com/users/octocat/events{/privacy} received_events_url: type: string format: uri example: https://api.github.com/users/octocat/received_events type: type: string example: User site_admin: type: boolean example: true starred_at: type: string example: '"2020-07-09T00:17:55Z"' required: - avatar_url - events_url - followers_url - following_url - gists_url - gravatar_id - html_url - id - node_id - login - organizations_url - received_events_url - repos_url - site_admin - starred_url - subscriptions_url - type - url dependabot-alert-with-repository: type: object description: A Dependabot alert. properties: number: $ref: '#/components/schemas/alert-number' state: type: string description: The state of the Dependabot alert. readOnly: true enum: - auto_dismissed - dismissed - fixed - open example: auto_dismissed dependency: type: object description: Details for the vulnerable dependency. readOnly: true properties: package: $ref: '#/components/schemas/dependabot-alert-package' manifest_path: type: string description: The full path to the dependency manifest file, relative to the root of the repository. readOnly: true scope: type: string description: The execution scope of the vulnerable dependency. readOnly: true nullable: true enum: - development - runtime security_advisory: $ref: '#/components/schemas/dependabot-alert-security-advisory' security_vulnerability: $ref: '#/components/schemas/dependabot-alert-security-vulnerability' url: $ref: '#/components/schemas/alert-url' html_url: $ref: '#/components/schemas/alert-html-url' created_at: $ref: '#/components/schemas/alert-created-at' updated_at: $ref: '#/components/schemas/alert-updated-at' dismissed_at: $ref: '#/components/schemas/alert-dismissed-at' dismissed_by: $ref: '#/components/schemas/nullable-simple-user' dismissed_reason: type: string description: The reason that the alert was dismissed. nullable: true enum: - fix_started - inaccurate - no_bandwidth - not_used - tolerable_risk example: fix_started dismissed_comment: type: string description: An optional comment associated with the alert's dismissal. nullable: true maxLength: 280 example: example_value fixed_at: $ref: '#/components/schemas/alert-fixed-at' auto_dismissed_at: $ref: '#/components/schemas/alert-auto-dismissed-at' repository: $ref: '#/components/schemas/simple-repository' 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 - repository additionalProperties: false secret-scanning-location-issue-title: description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. type: object properties: issue_title_url: type: string format: uri description: The API URL to get the issue where the secret was detected. example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_title_url alert-fixed-at_3: type: string description: 'The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true alert-dismissed-at_2: type: string description: 'The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true organization-secret-scanning-alert: type: object properties: number: $ref: '#/components/schemas/alert-number' created_at: $ref: '#/components/schemas/alert-created-at' updated_at: $ref: '#/components/schemas/nullable-alert-updated-at' url: $ref: '#/components/schemas/alert-url' html_url: $ref: '#/components/schemas/alert-html-url' locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. example: https://api.github.com/repos/octocat/Hello-World state: $ref: '#/components/schemas/secret-scanning-alert-state' resolution: $ref: '#/components/schemas/secret-scanning-alert-resolution' resolved_at: type: string format: date-time description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' nullable: true example: '2026-04-17T12:00:00Z' resolved_by: $ref: '#/components/schemas/nullable-simple-user' secret_type: type: string description: The type of secret that secret scanning detected. example: User secret_type_display_name: type: string description: 'User-friendly name for the detected secret, matching the `secret_type`. For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)."' example: octocat secret: type: string description: The secret that was detected. example: example_value repository: $ref: '#/components/schemas/simple-repository' push_protection_bypassed: type: boolean description: Whether push protection was bypassed for the detected secret. nullable: true example: true push_protection_bypassed_by: $ref: '#/components/schemas/nullable-simple-user' push_protection_bypassed_at: type: string format: date-time description: 'The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' nullable: true example: '2026-04-17T12:00:00Z' resolution_comment: type: string description: The comment that was optionally added when this alert was closed nullable: true example: example_value alert-number: type: integer description: The security alert number. readOnly: true alert-instances-url: type: string description: The REST API URL for fetching the list of instances for an alert. format: uri readOnly: true code-scanning-alert-state: type: string description: State of a code scanning alert. enum: - open - dismissed - fixed code-scanning-alert-dismissed-reason_2: type: string description: '**Required when the state is dismissed.** The reason for dismissing or closing the alert.' enum: - false positive - won't fix - used in tests code-scanning-alert: type: object properties: number: $ref: '#/components/schemas/alert-number' created_at: $ref: '#/components/schemas/alert-created-at' updated_at: $ref: '#/components/schemas/alert-updated-at' url: $ref: '#/components/schemas/alert-url' html_url: $ref: '#/components/schemas/alert-html-url' instances_url: $ref: '#/components/schemas/alert-instances-url' state: $ref: '#/components/schemas/code-scanning-alert-state' fixed_at: $ref: '#/components/schemas/alert-fixed-at_2' dismissed_by: $ref: '#/components/schemas/nullable-simple-user_2' dismissed_at: $ref: '#/components/schemas/alert-dismissed-at_2' dismissed_reason: $ref: '#/components/schemas/code-scanning-alert-dismissed-reason_2' dismissed_comment: $ref: '#/components/schemas/code-scanning-alert-dismissed-comment_2' rule: $ref: '#/components/schemas/code-scanning-alert-rule' tool: $ref: '#/components/schemas/code-scanning-analysis-tool' most_recent_instance: $ref: '#/components/schemas/code-scanning-alert-instance' required: - number - created_at - url - html_url - instances_url - state - dismissed_by - dismissed_at - dismissed_reason - rule - tool - most_recent_instance code-scanning-alert-dismissed-reason: type: string description: '**Required when the state is dismissed.** The reason for dismissing or closing the alert.' nullable: true enum: - null - false positive - won't fix - used in tests secret-scanning-location-issue-body: description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. type: object properties: issue_body_url: type: string format: uri description: The API URL to get the issue where the secret was detected. example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_body_url code-scanning-alert-state-query: type: string description: State of a code scanning alert. enum: - open - closed - dismissed - fixed 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 simple-user: title: Simple User description: A GitHub user. type: object properties: name: nullable: true type: string example: octocat email: nullable: true type: string example: octocat@github.com login: type: string example: octocat id: type: integer example: 1 node_id: type: string example: MDQ6VXNlcjE= avatar_url: type: string format: uri example: https://github.com/images/error/octocat_happy.gif gravatar_id: type: string example: 41d064eb2195891e12d0413f63227ea7 nullable: true url: type: string format: uri example: https://api.github.com/users/octocat html_url: type: string format: uri example: https://github.com/octocat followers_url: type: string format: uri example: https://api.github.com/users/octocat/followers following_url: type: string example: https://api.github.com/users/octocat/following{/other_user} gists_url: type: string example: https://api.github.com/users/octocat/gists{/gist_id} starred_url: type: string example: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: type: string format: uri example: https://api.github.com/users/octocat/subscriptions organizations_url: type: string format: uri example: https://api.github.com/users/octocat/orgs repos_url: type: string format: uri example: https://api.github.com/users/octocat/repos events_url: type: string example: https://api.github.com/users/octocat/events{/privacy} received_events_url: type: string format: uri example: https://api.github.com/users/octocat/received_events type: type: string example: User site_admin: type: boolean example: true starred_at: type: string example: '"2020-07-09T00:17:55Z"' required: - avatar_url - events_url - followers_url - following_url - gists_url - gravatar_id - html_url - id - node_id - login - organizations_url - received_events_url - repos_url - site_admin - starred_url - subscriptions_url - type - url code-scanning-alert-location: type: object description: Describe a region within a file for the alert. properties: path: type: string example: src/index.js start_line: type: integer example: 42 end_line: type: integer example: 42 start_column: type: integer example: 42 end_column: type: integer example: 42 code-scanning-alert-set-state: description: Sets the state of the code scanning alert. You must provide `dismissed_reason` when you set the state to `dismissed`. type: string enum: - open - dismissed dependabot-alert-security-vulnerability: type: object description: Details pertaining to one vulnerable version range for the advisory. readOnly: true properties: package: $ref: '#/components/schemas/dependabot-alert-package' severity: type: string description: The severity of the vulnerability. readOnly: true enum: - low - medium - high - critical example: low vulnerable_version_range: type: string description: Conditions that identify vulnerable versions of this vulnerability's package. readOnly: true example: example_value first_patched_version: type: object description: Details pertaining to the package version that patches this vulnerability. readOnly: true nullable: true properties: identifier: type: string description: The package version that patches this vulnerability. readOnly: true required: - identifier additionalProperties: false required: - package - severity - vulnerable_version_range - first_patched_version additionalProperties: false code-scanning-alert-dismissed-comment: type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 alert-auto-dismissed-at_2: type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true code-scanning-ref: type: string description: 'The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``.' secret-scanning-alert-resolution_2: type: string description: '**Required when the `state` is `resolved`.** The reason for resolving the alert.' enum: - false_positive - wont_fix - revoked - used_in_tests secret-scanning-location-pull-request-review-comment: description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. type: object properties: pull_request_review_comment_url: type: string format: uri description: The API URL to get the pull request review comment where the secret was detected. example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 required: - pull_request_review_comment_url alert-url: type: string description: The REST API URL of the alert resource. format: uri readOnly: true code-scanning-alert-dismissed-comment_2: type: string description: The dismissal comment associated with the dismissal of the alert. maxLength: 280 responses: forbidden: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/basic-error' service_unavailable: description: Service unavailable content: application/json: schema: type: object properties: code: type: string message: type: string documentation_url: type: string bad_request: description: Bad Request content: application/json: schema: $ref: '#/components/schemas/basic-error' application/scim+json: schema: $ref: '#/components/schemas/scim-error' code_scanning_forbidden_write: description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: application/json: schema: $ref: '#/components/schemas/basic-error' validation_failed_simple: description: Validation failed, or the endpoint has been spammed. content: application/json: schema: $ref: '#/components/schemas/validation-error-simple' code_scanning_forbidden_read: description: Response if GitHub Advanced Security is not enabled for this repository content: application/json: schema: $ref: '#/components/schemas/basic-error' conflict: description: Conflict content: application/json: schema: $ref: '#/components/schemas/basic-error' not_found: description: Resource not found content: application/json: schema: $ref: '#/components/schemas/basic-error' not_modified: description: Not modified parameters: git-ref: name: ref description: The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. in: query required: false schema: $ref: '#/components/schemas/code-scanning-ref' secret-scanning-pagination-after-org-repo_2: name: after description: cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. in: query required: false schema: type: string secret-scanning-pagination-before-org-repo_2: name: before description: cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. in: query required: false schema: type: string dependabot-alert-comma-separated-ecosystems: name: ecosystem in: query description: 'A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`' schema: type: string secret-scanning-alert-secret-type_2: name: secret_type in: query description: 'comma-separated list of secret types to return. By default all secret types are returned. See "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" for a complete list of secret types.' required: false schema: type: string repo: name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. in: path required: true schema: type: string per-page: name: per_page description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer default: 30 pagination-before_2: name: before description: cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query required: false schema: type: string pagination-after: name: after description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query required: false schema: type: string secret-scanning-alert-resolution_2: name: resolution in: query description: comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. required: false schema: type: string dependabot-alert-comma-separated-ecosystems_2: name: ecosystem in: query description: 'comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`' schema: type: string pagination-after_2: name: after description: cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query required: false schema: type: string pagination-last: name: last description: '**Deprecated**. The number of results per page (max 100), starting from the last matching result. This parameter must not be used in combination with `first`. Instead, use `per_page` in combination with `before` to fetch the last page of results.' in: query required: false schema: type: integer minimum: 1 maximum: 100 dependabot-alert-sort: name: sort in: query description: 'The property by which to sort the results. `created` means when the alert was created. `updated` means when the alert''s state last changed.' schema: type: string enum: - created - updated default: created tool-guid: name: tool_guid description: The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. in: query required: false schema: $ref: '#/components/schemas/code-scanning-analysis-tool-guid' dependabot-alert-comma-separated-states: name: state in: query description: 'A comma-separated list of states. If specified, only alerts with these states will be returned. Can be: `auto_dismissed`, `dismissed`, `fixed`, `open`' schema: type: string dependabot-alert-comma-separated-packages: name: package in: query description: A comma-separated list of package names. If specified, only alerts for these packages will be returned. schema: type: string secret-scanning-alert-secret-type: name: secret_type in: query description: 'A comma-separated list of secret types to return. By default all secret types are returned. See "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" for a complete list of secret types.' required: false schema: type: string dependabot-alert-comma-separated-states_2: name: state in: query description: 'comma-separated list of states. If specified, only alerts with these states will be returned. Can be: `auto_dismissed`, `dismissed`, `fixed`, `open`' schema: type: string dependabot-alert-comma-separated-manifests: name: manifest in: query description: comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. schema: type: string dependabot-alert-comma-separated-severities: name: severity in: query description: 'A comma-separated list of severities. If specified, only alerts with these severities will be returned. Can be: `low`, `medium`, `high`, `critical`' schema: type: string dependabot-alert-comma-separated-severities_2: name: severity in: query description: 'comma-separated list of severities. If specified, only alerts with these severities will be returned. Can be: `low`, `medium`, `high`, `critical`' schema: type: string tool-name: name: tool_name description: The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. in: query required: false schema: $ref: '#/components/schemas/code-scanning-analysis-tool-name' pagination-first: name: first description: '**Deprecated**. The number of results per page (max 100), starting from the first matching result. This parameter must not be used in combination with `last`. Instead, use `per_page` in combination with `after` to fetch the first page of results.' in: query required: false schema: type: integer minimum: 1 maximum: 100 default: 30 dependabot-alert-comma-separated-packages_2: name: package in: query description: comma-separated list of package names. If specified, only alerts for these packages will be returned. schema: type: string org: name: org description: The organization name. The name is not case sensitive. in: path required: true schema: type: string secret-scanning-alert-resolution: name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. required: false schema: type: string secret-scanning-pagination-before-org-repo: name: before description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. in: query required: false schema: type: string dependabot-alert-number: name: alert_number in: path description: 'The number that identifies a Dependabot alert in its repository. You can find this at the end of the URL for a Dependabot alert within GitHub, or in `number` fields in the response from the `GET /repos/{owner}/{repo}/dependabot/alerts` operation.' required: true schema: $ref: '#/components/schemas/alert-number' owner: name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string direction: name: direction description: The direction to sort the results by. in: query required: false schema: type: string enum: - asc - desc default: desc secret-scanning-alert-state: name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts in a specific state. required: false schema: type: string enum: - open - resolved alert-number: name: alert_number in: path description: The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. required: true schema: $ref: '#/components/schemas/alert-number' dependabot-alert-scope: name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. schema: type: string enum: - development - runtime secret-scanning-alert-sort: name: sort description: The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. in: query required: false schema: type: string enum: - created - updated default: created pagination-before: name: before description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query required: false schema: type: string page: name: page description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer default: 1 secret-scanning-pagination-after-org-repo: name: after description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. in: query required: false schema: type: string examples: secret-scanning-location-list: value: - 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/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b commit_sha: f14d7debf9775f957cf4f1e8176da0786431f72b commit_url: https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b - type: commit details: path: /example/Home.md start_line: 1 end_line: 1 start_column: 1 end_column: 64 blob_sha: af5626b4a114abcb82d63db7c8082c3c4756e51b page_url: https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 commit_sha: 302c0b7e200761c9dd9b57e57db540ee0b4293a5 commit_url: https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 blob_url: 'https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt ' - type: issue_title details: issue_title_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 - type: issue_body details: issue_body_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 - type: issue_comment details: issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - type: discussion_title details: discussion_title_url: https://github.com/community/community/discussions/39082 - type: discussion_body details: discussion_body_url: https://github.com/community/community/discussions/39082#discussion-4566270 - type: discussion_comment details: discussion_comment_url: https://github.com/community/community/discussions/39082#discussioncomment-4158232 - type: pull_request_title details: pull_request_title_url: https://api.github.com/repos/octocat/Hello-World/pull/2846 - type: pull_request_body details: pull_request_body_url: https://api.github.com/repos/octocat/Hello-World/pulls/2846 - type: pull_request_comment details: pull_request_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments/1825855898 - type: pull_request_review details: pull_request_review_url: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 - type: pull_request_review_comment details: pull_request_review_comment_url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 dependabot-alerts-for-organization: value: - number: 2 state: dismissed dependency: package: ecosystem: pip name: django manifest_path: path/to/requirements.txt scope: runtime security_advisory: ghsa_id: GHSA-rf4j-j272-fj86 cve_id: CVE-2018-6188 summary: Django allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive description: django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive. vulnerabilities: - package: ecosystem: pip name: django severity: high vulnerable_version_range: '>= 2.0.0, < 2.0.2' first_patched_version: identifier: 2.0.2 - package: ecosystem: pip name: django severity: high vulnerable_version_range: '>= 1.11.8, < 1.11.10' first_patched_version: identifier: 1.11.10 severity: high cvss: vector_string: CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N score: 7.5 cwes: - cwe_id: CWE-200 name: Exposure of Sensitive Information to an Unauthorized Actor identifiers: - type: GHSA value: GHSA-rf4j-j272-fj86 - type: CVE value: CVE-2018-6188 references: - url: https://nvd.nist.gov/vuln/detail/CVE-2018-6188 - url: https://github.com/advisories/GHSA-rf4j-j272-fj86 - url: https://usn.ubuntu.com/3559-1/ - url: https://www.djangoproject.com/weblog/2018/feb/01/security-releases/ - url: http://www.securitytracker.com/id/1040422 published_at: '2018-10-03T21:13:54Z' updated_at: '2022-04-26T18:35:37Z' withdrawn_at: null security_vulnerability: package: ecosystem: pip name: django severity: high vulnerable_version_range: '>= 2.0.0, < 2.0.2' first_patched_version: identifier: 2.0.2 url: https://api.github.com/repos/octo-org/octo-repo/dependabot/alerts/2 html_url: https://github.com/octo-org/octo-repo/security/dependabot/2 created_at: '2022-06-15T07:43:03Z' updated_at: '2022-08-23T14:29:47Z' dismissed_at: '2022-08-23T14:29:47Z' dismissed_by: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false dismissed_reason: tolerable_risk dismissed_comment: This alert is accurate but we use a sanitizer. fixed_at: null repository: id: 217723378 node_id: MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg= name: octo-repo full_name: octo-org/octo-repo owner: login: octo-org id: 6811672 node_id: MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI= avatar_url: https://avatars3.githubusercontent.com/u/6811672?v=4 gravatar_id: '' url: https://api.github.com/users/octo-org html_url: https://github.com/octo-org followers_url: https://api.github.com/users/octo-org/followers following_url: https://api.github.com/users/octo-org/following{/other_user} gists_url: https://api.github.com/users/octo-org/gists{/gist_id} starred_url: https://api.github.com/users/octo-org/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octo-org/subscriptions organizations_url: https://api.github.com/users/octo-org/orgs repos_url: https://api.github.com/users/octo-org/repos events_url: https://api.github.com/users/octo-org/events{/privacy} received_events_url: https://api.github.com/users/octo-org/received_events type: Organization site_admin: false private: true html_url: https://github.com/octo-org/octo-repo description: null fork: false url: https://api.github.com/repos/octo-org/octo-repo archive_url: https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref} assignees_url: https://api.github.com/repos/octo-org/octo-repo/assignees{/user} blobs_url: https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha} branches_url: https://api.github.com/repos/octo-org/octo-repo/branches{/branch} collaborators_url: https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator} comments_url: https://api.github.com/repos/octo-org/octo-repo/comments{/number} commits_url: https://api.github.com/repos/octo-org/octo-repo/commits{/sha} compare_url: https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head} contents_url: https://api.github.com/repos/octo-org/octo-repo/contents/{+path} contributors_url: https://api.github.com/repos/octo-org/octo-repo/contributors deployments_url: https://api.github.com/repos/octo-org/octo-repo/deployments downloads_url: https://api.github.com/repos/octo-org/octo-repo/downloads events_url: https://api.github.com/repos/octo-org/octo-repo/events forks_url: https://api.github.com/repos/octo-org/octo-repo/forks git_commits_url: https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha} git_refs_url: https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha} git_tags_url: https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha} hooks_url: https://api.github.com/repos/octo-org/octo-repo/hooks issue_comment_url: https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number} issue_events_url: https://api.github.com/repos/octo-org/octo-repo/issues/events{/number} issues_url: https://api.github.com/repos/octo-org/octo-repo/issues{/number} keys_url: https://api.github.com/repos/octo-org/octo-repo/keys{/key_id} labels_url: https://api.github.com/repos/octo-org/octo-repo/labels{/name} languages_url: https://api.github.com/repos/octo-org/octo-repo/languages merges_url: https://api.github.com/repos/octo-org/octo-repo/merges milestones_url: https://api.github.com/repos/octo-org/octo-repo/milestones{/number} notifications_url: https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating} pulls_url: https://api.github.com/repos/octo-org/octo-repo/pulls{/number} releases_url: https://api.github.com/repos/octo-org/octo-repo/releases{/id} stargazers_url: https://api.github.com/repos/octo-org/octo-repo/stargazers statuses_url: https://api.github.com/repos/octo-org/octo-repo/statuses/{sha} subscribers_url: https://api.github.com/repos/octo-org/octo-repo/subscribers subscription_url: https://api.github.com/repos/octo-org/octo-repo/subscription tags_url: https://api.github.com/repos/octo-org/octo-repo/tags teams_url: https://api.github.com/repos/octo-org/octo-repo/teams trees_url: https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha} - number: 1 state: open dependency: package: ecosystem: pip name: ansible manifest_path: path/to/requirements.txt scope: runtime security_advisory: ghsa_id: GHSA-8f4m-hccc-8qph cve_id: CVE-2021-20191 summary: Insertion of Sensitive Information into Log File in ansible description: A flaw was found in ansible. Credentials, such as secrets, are being disclosed in console log by default and not protected by no_log feature when using those modules. An attacker can take advantage of this information to steal those credentials. The highest threat from this vulnerability is to data confidentiality. vulnerabilities: - package: ecosystem: pip name: ansible severity: medium vulnerable_version_range: '>= 2.9.0, < 2.9.18' first_patched_version: identifier: 2.9.18 - package: ecosystem: pip name: ansible severity: medium vulnerable_version_range: < 2.8.19 first_patched_version: identifier: 2.8.19 - package: ecosystem: pip name: ansible severity: medium vulnerable_version_range: '>= 2.10.0, < 2.10.7' first_patched_version: identifier: 2.10.7 severity: medium cvss: vector_string: CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N score: 5.5 cwes: - cwe_id: CWE-532 name: Insertion of Sensitive Information into Log File identifiers: - type: GHSA value: GHSA-8f4m-hccc-8qph - type: CVE value: CVE-2021-20191 references: - url: https://nvd.nist.gov/vuln/detail/CVE-2021-20191 - url: https://access.redhat.com/security/cve/cve-2021-20191 - url: https://bugzilla.redhat.com/show_bug.cgi?id=1916813 published_at: '2021-06-01T17:38:00Z' updated_at: '2021-08-12T23:06:00Z' withdrawn_at: null security_vulnerability: package: ecosystem: pip name: ansible severity: medium vulnerable_version_range: < 2.8.19 first_patched_version: identifier: 2.8.19 url: https://api.github.com/repos/octo-org/hello-world/dependabot/alerts/1 html_url: https://github.com/octo-org/hello-world/security/dependabot/1 created_at: '2022-06-14T15:21:52Z' updated_at: '2022-06-14T15:21:52Z' dismissed_at: null dismissed_by: null dismissed_reason: null dismissed_comment: null fixed_at: null repository: id: 664700648 node_id: MDEwOlJlcG9zaXRvcnk2NjQ3MDA2NDg= name: hello-world full_name: octo-org/hello-world owner: login: octo-org id: 6811672 node_id: MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI= avatar_url: https://avatars3.githubusercontent.com/u/6811672?v=4 gravatar_id: '' url: https://api.github.com/users/octo-org html_url: https://github.com/octo-org followers_url: https://api.github.com/users/octo-org/followers following_url: https://api.github.com/users/octo-org/following{/other_user} gists_url: https://api.github.com/users/octo-org/gists{/gist_id} starred_url: https://api.github.com/users/octo-org/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octo-org/subscriptions organizations_url: https://api.github.com/users/octo-org/orgs repos_url: https://api.github.com/users/octo-org/repos events_url: https://api.github.com/users/octo-org/events{/privacy} received_events_url: https://api.github.com/users/octo-org/received_events type: Organization site_admin: false private: true html_url: https://github.com/octo-org/hello-world description: null fork: false url: https://api.github.com/repos/octo-org/hello-world archive_url: https://api.github.com/repos/octo-org/hello-world/{archive_format}{/ref} assignees_url: https://api.github.com/repos/octo-org/hello-world/assignees{/user} blobs_url: https://api.github.com/repos/octo-org/hello-world/git/blobs{/sha} branches_url: https://api.github.com/repos/octo-org/hello-world/branches{/branch} collaborators_url: https://api.github.com/repos/octo-org/hello-world/collaborators{/collaborator} comments_url: https://api.github.com/repos/octo-org/hello-world/comments{/number} commits_url: https://api.github.com/repos/octo-org/hello-world/commits{/sha} compare_url: https://api.github.com/repos/octo-org/hello-world/compare/{base}...{head} contents_url: https://api.github.com/repos/octo-org/hello-world/contents/{+path} contributors_url: https://api.github.com/repos/octo-org/hello-world/contributors deployments_url: https://api.github.com/repos/octo-org/hello-world/deployments downloads_url: https://api.github.com/repos/octo-org/hello-world/downloads events_url: https://api.github.com/repos/octo-org/hello-world/events forks_url: https://api.github.com/repos/octo-org/hello-world/forks git_commits_url: https://api.github.com/repos/octo-org/hello-world/git/commits{/sha} git_refs_url: https://api.github.com/repos/octo-org/hello-world/git/refs{/sha} git_tags_url: https://api.github.com/repos/octo-org/hello-world/git/tags{/sha} hooks_url: https://api.github.com/repos/octo-org/hello-world/hooks issue_comment_url: https://api.github.com/repos/octo-org/hello-world/issues/comments{/number} issue_events_url: https://api.github.com/repos/octo-org/hello-world/issues/events{/number} issues_url: https://api.github.com/repos/octo-org/hello-world/issues{/number} keys_url: https://api.github.com/repos/octo-org/hello-world/keys{/key_id} labels_url: https://api.github.com/repos/octo-org/hello-world/labels{/name} languages_url: https://api.github.com/repos/octo-org/hello-world/languages merges_url: https://api.github.com/repos/octo-org/hello-world/merges milestones_url: https://api.github.com/repos/octo-org/hello-world/milestones{/number} notifications_url: https://api.github.com/repos/octo-org/hello-world/notifications{?since,all,participating} pulls_url: https://api.github.com/repos/octo-org/hello-world/pulls{/number} releases_url: https://api.github.com/repos/octo-org/hello-world/releases{/id} stargazers_url: https://api.github.com/repos/octo-org/hello-world/stargazers statuses_url: https://api.github.com/repos/octo-org/hello-world/statuses/{sha} subscribers_url: https://api.github.com/repos/octo-org/hello-world/subscribers subscription_url: https://api.github.com/repos/octo-org/hello-world/subscription tags_url: https://api.github.com/repos/octo-org/hello-world/tags teams_url: https://api.github.com/repos/octo-org/hello-world/teams trees_url: https://api.github.com/repos/octo-org/hello-world/git/trees{/sha} dependabot-alert-dismissed: value: number: 2 state: dismissed dependency: package: ecosystem: pip name: django manifest_path: path/to/requirements.txt scope: runtime security_advisory: ghsa_id: GHSA-rf4j-j272-fj86 cve_id: CVE-2018-6188 summary: Django allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive description: django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive. vulnerabilities: - package: ecosystem: pip name: django severity: high vulnerable_version_range: '>= 2.0.0, < 2.0.2' first_patched_version: identifier: 2.0.2 - package: ecosystem: pip name: django severity: high vulnerable_version_range: '>= 1.11.8, < 1.11.10' first_patched_version: identifier: 1.11.10 severity: high cvss: vector_string: CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N score: 7.5 cwes: - cwe_id: CWE-200 name: Exposure of Sensitive Information to an Unauthorized Actor identifiers: - type: GHSA value: GHSA-rf4j-j272-fj86 - type: CVE value: CVE-2018-6188 references: - url: https://nvd.nist.gov/vuln/detail/CVE-2018-6188 - url: https://github.com/advisories/GHSA-rf4j-j272-fj86 - url: https://usn.ubuntu.com/3559-1/ - url: https://www.djangoproject.com/weblog/2018/feb/01/security-releases/ - url: http://www.securitytracker.com/id/1040422 published_at: '2018-10-03T21:13:54Z' updated_at: '2022-04-26T18:35:37Z' withdrawn_at: '2022-04-26T18:35:37Z' security_vulnerability: package: ecosystem: pip name: django severity: high vulnerable_version_range: '>= 2.0.0, < 2.0.2' first_patched_version: identifier: 2.0.2 url: https://api.github.com/repos/octocat/hello-world/dependabot/alerts/2 html_url: https://github.com/octocat/hello-world/security/dependabot/2 created_at: '2022-06-15T07:43:03Z' updated_at: '2022-08-23T14:29:47Z' dismissed_at: '2022-08-23T14:29:47Z' dismissed_by: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false dismissed_reason: tolerable_risk dismissed_comment: This alert is accurate but we use a sanitizer. fixed_at: '2020-02-14T12:29:18Z' dependabot-alert-open: value: number: 1 state: open dependency: package: ecosystem: pip name: ansible manifest_path: path/to/requirements.txt scope: runtime security_advisory: ghsa_id: GHSA-8f4m-hccc-8qph cve_id: CVE-2021-20191 summary: Insertion of Sensitive Information into Log File in ansible description: flaw was found in ansible. Credentials, such as secrets, are being disclosed in console log by default and not protected by no_log feature when using those modules. An attacker can take advantage of this information to steal those credentials. The highest threat from this vulnerability is to data confidentiality. vulnerabilities: - package: ecosystem: pip name: ansible severity: medium vulnerable_version_range: '>= 2.9.0, < 2.9.18' first_patched_version: identifier: 2.9.18 - package: ecosystem: pip name: ansible severity: medium vulnerable_version_range: < 2.8.19 first_patched_version: identifier: 2.8.19 - package: ecosystem: pip name: ansible severity: medium vulnerable_version_range: '>= 2.10.0, < 2.10.7' first_patched_version: identifier: 2.10.7 severity: medium cvss: vector_string: CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N score: 5.5 cwes: - cwe_id: CWE-532 name: Insertion of Sensitive Information into Log File identifiers: - type: GHSA value: GHSA-8f4m-hccc-8qph - type: CVE value: CVE-2021-20191 references: - url: https://nvd.nist.gov/vuln/detail/CVE-2021-20191 - url: https://access.redhat.com/security/cve/cve-2021-20191 - url: https://bugzilla.redhat.com/show_bug.cgi?id=1916813 published_at: '2021-06-01T17:38:00Z' updated_at: '2021-08-12T23:06:00Z' withdrawn_at: '2022-04-26T18:35:37Z' security_vulnerability: package: ecosystem: pip name: ansible severity: medium vulnerable_version_range: < 2.8.19 first_patched_version: identifier: 2.8.19 url: https://api.github.com/repos/octocat/hello-world/dependabot/alerts/1 html_url: https://github.com/octocat/hello-world/security/dependabot/1 created_at: '2022-06-14T15:21:52Z' updated_at: '2022-06-14T15:21:52Z' dismissed_at: '2020-02-14T12:29:18Z' dismissed_by: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false dismissed_reason: fix_started dismissed_comment: '' fixed_at: '2020-02-14T12:29:18Z' code-scanning-alert: value: number: 42 created_at: '2020-06-19T11:21:34Z' url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42 html_url: https://github.com/octocat/hello-world/code-scanning/42 state: dismissed fixed_at: '2018-05-04T01:14:52Z' dismissed_by: login: octocat id: 54933897 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false dismissed_at: '2020-02-14T12:29:18Z' dismissed_reason: false positive dismissed_comment: This alert is not actually correct, because there's a sanitizer included in the library. rule: id: js/zipslip severity: error security_severity_level: high description: Arbitrary file write during zip extraction ("Zip Slip") name: js/zipslip full_description: Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten. tags: - security - external/cwe/cwe-022 help: '# Arbitrary file write during zip extraction ("Zip Slip")\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...' help_uri: https://codeql.github.com/ tool: name: CodeQL guid: 326aa09f-9af8-13cf-9851-3d0e5183ec38 version: 2.4.0 most_recent_instance: ref: refs/heads/main analysis_key: .github/workflows/codeql-analysis.yml:CodeQL-Build category: .github/workflows/codeql-analysis.yml:CodeQL-Build environment: '{}' state: dismissed commit_sha: 39406e42cb832f683daa691dd652a8dc36ee8930 message: text: This path depends on a user-provided value. location: path: spec-main/api-session-spec.ts start_line: 917 end_line: 917 start_column: 7 end_column: 18 classifications: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances code-scanning-alert-dismissed: value: number: 42 created_at: '2020-08-25T21:28:36Z' url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42 html_url: https://github.com/octocat/hello-world/code-scanning/42 state: dismissed fixed_at: '2018-05-04T01:14:52Z' dismissed_by: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false dismissed_at: '2020-09-02T22:34:56Z' dismissed_reason: false positive dismissed_comment: This alert is not actually correct, because there's a sanitizer included in the library. rule: id: js/zipslip severity: error security_severity_level: high description: Arbitrary file write during zip extraction ("Zip Slip") name: js/zipslip full_description: Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten. tags: - security - external/cwe/cwe-022 help: '# Arbitrary file write during zip extraction ("Zip Slip")\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...' help_uri: https://codeql.github.com/ tool: name: CodeQL guid: 326aa09f-9af8-13cf-9851-3d0e5183ec38 version: 2.4.0 most_recent_instance: ref: refs/heads/main analysis_key: .github/workflows/codeql-analysis.yml:CodeQL-Build category: .github/workflows/codeql-analysis.yml:CodeQL-Build environment: '{}' state: dismissed commit_sha: 39406e42cb832f683daa691dd652a8dc36ee8930 message: text: This path depends on a user-provided value. location: path: spec-main/api-session-spec.ts start_line: 917 end_line: 917 start_column: 7 end_column: 18 classifications: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances secret-scanning-alert-resolved: value: number: 42 created_at: '2020-11-06T18:18:30Z' url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42 html_url: https://github.com/owner/private-repo/security/secret-scanning/42 locations_url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42/locations state: resolved resolution: used_in_tests resolved_at: '2020-11-16T22:42:07Z' resolved_by: login: monalisa id: 2 node_id: MDQ6VXNlcjI= avatar_url: https://alambic.github.com/avatars/u/2? gravatar_id: '' url: https://api.github.com/users/monalisa html_url: https://github.com/monalisa followers_url: https://api.github.com/users/monalisa/followers following_url: https://api.github.com/users/monalisa/following{/other_user} gists_url: https://api.github.com/users/monalisa/gists{/gist_id} starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/monalisa/subscriptions organizations_url: https://api.github.com/users/monalisa/orgs repos_url: https://api.github.com/users/monalisa/repos events_url: https://api.github.com/users/monalisa/events{/privacy} received_events_url: https://api.github.com/users/monalisa/received_events type: User site_admin: true secret_type: mailchimp_api_key secret_type_display_name: Mailchimp API Key secret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2 push_protection_bypassed: false resolution_comment: Example comment secret-scanning-alert-list: value: - number: 2 created_at: '2020-11-06T18:48:51Z' url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2 html_url: https://github.com/owner/private-repo/security/secret-scanning/2 locations_url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations state: resolved resolution: false_positive resolved_at: '2020-11-07T02:47:13Z' resolved_by: login: monalisa id: 2 node_id: MDQ6VXNlcjI= avatar_url: https://alambic.github.com/avatars/u/2? gravatar_id: '' url: https://api.github.com/users/monalisa html_url: https://github.com/monalisa followers_url: https://api.github.com/users/monalisa/followers following_url: https://api.github.com/users/monalisa/following{/other_user} gists_url: https://api.github.com/users/monalisa/gists{/gist_id} starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/monalisa/subscriptions organizations_url: https://api.github.com/users/monalisa/orgs repos_url: https://api.github.com/users/monalisa/repos events_url: https://api.github.com/users/monalisa/events{/privacy} received_events_url: https://api.github.com/users/monalisa/received_events type: User site_admin: true secret_type: adafruit_io_key secret_type_display_name: Adafruit IO Key secret: aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX push_protection_bypassed_by: login: monalisa id: 2 node_id: MDQ6VXNlcjI= avatar_url: https://alambic.github.com/avatars/u/2? gravatar_id: '' url: https://api.github.com/users/monalisa html_url: https://github.com/monalisa followers_url: https://api.github.com/users/monalisa/followers following_url: https://api.github.com/users/monalisa/following{/other_user} gists_url: https://api.github.com/users/monalisa/gists{/gist_id} starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/monalisa/subscriptions organizations_url: https://api.github.com/users/monalisa/orgs repos_url: https://api.github.com/users/monalisa/repos events_url: https://api.github.com/users/monalisa/events{/privacy} received_events_url: https://api.github.com/users/monalisa/received_events type: User site_admin: true push_protection_bypassed: true push_protection_bypassed_at: '2020-11-06T21:48:51Z' resolution_comment: Example comment - number: 1 created_at: '2020-11-06T18:18:30Z' url: https://api.github.com/repos/owner/repo/secret-scanning/alerts/1 html_url: https://github.com/owner/repo/security/secret-scanning/1 locations_url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/1/locations state: open resolution: false_positive resolved_at: '2020-11-06T21:48:51Z' resolved_by: login: monalisa id: 2 node_id: MDQ6VXNlcjI= avatar_url: https://alambic.github.com/avatars/u/2? gravatar_id: '' url: https://api.github.com/users/monalisa html_url: https://github.com/monalisa followers_url: https://api.github.com/users/monalisa/followers following_url: https://api.github.com/users/monalisa/following{/other_user} gists_url: https://api.github.com/users/monalisa/gists{/gist_id} starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/monalisa/subscriptions organizations_url: https://api.github.com/users/monalisa/orgs repos_url: https://api.github.com/users/monalisa/repos events_url: https://api.github.com/users/monalisa/events{/privacy} received_events_url: https://api.github.com/users/monalisa/received_events type: User site_admin: true secret_type: mailchimp_api_key secret_type_display_name: Mailchimp API Key secret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2 push_protection_bypassed_by: login: monalisa id: 2 node_id: MDQ6VXNlcjI= avatar_url: https://alambic.github.com/avatars/u/2? gravatar_id: '' url: https://api.github.com/users/monalisa html_url: https://github.com/monalisa followers_url: https://api.github.com/users/monalisa/followers following_url: https://api.github.com/users/monalisa/following{/other_user} gists_url: https://api.github.com/users/monalisa/gists{/gist_id} starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/monalisa/subscriptions organizations_url: https://api.github.com/users/monalisa/orgs repos_url: https://api.github.com/users/monalisa/repos events_url: https://api.github.com/users/monalisa/events{/privacy} received_events_url: https://api.github.com/users/monalisa/received_events type: User site_admin: true push_protection_bypassed: false push_protection_bypassed_at: '2020-11-06T18:18:30Z' resolution_comment: It was resolved. organization-secret-scanning-alert-list: value: - number: 2 created_at: '2020-11-06T18:48:51Z' url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2 html_url: https://github.com/owner/private-repo/security/secret-scanning/2 locations_url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations state: resolved resolution: false_positive resolved_at: '2020-11-07T02:47:13Z' resolved_by: login: monalisa id: 2 node_id: MDQ6VXNlcjI= avatar_url: https://alambic.github.com/avatars/u/2? gravatar_id: '' url: https://api.github.com/users/monalisa html_url: https://github.com/monalisa followers_url: https://api.github.com/users/monalisa/followers following_url: https://api.github.com/users/monalisa/following{/other_user} gists_url: https://api.github.com/users/monalisa/gists{/gist_id} starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/monalisa/subscriptions organizations_url: https://api.github.com/users/monalisa/orgs repos_url: https://api.github.com/users/monalisa/repos events_url: https://api.github.com/users/monalisa/events{/privacy} received_events_url: https://api.github.com/users/monalisa/received_events type: User site_admin: true secret_type: adafruit_io_key secret_type_display_name: Adafruit IO Key secret: aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX repository: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 name: Hello-World full_name: octocat/Hello-World owner: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false private: false html_url: https://github.com/octocat/Hello-World description: This your first repo! fork: false url: https://api.github.com/repos/octocat/Hello-World archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads events_url: https://api.github.com/repos/octocat/Hello-World/events forks_url: https://api.github.com/repos/octocat/Hello-World/forks git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} languages_url: https://api.github.com/repos/octocat/Hello-World/languages merges_url: https://api.github.com/repos/octocat/Hello-World/merges milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription tags_url: https://api.github.com/repos/octocat/Hello-World/tags teams_url: https://api.github.com/repos/octocat/Hello-World/teams trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks push_protection_bypassed_by: login: monalisa id: 2 node_id: MDQ6VXNlcjI= avatar_url: https://alambic.github.com/avatars/u/2? gravatar_id: '' url: https://api.github.com/users/monalisa html_url: https://github.com/monalisa followers_url: https://api.github.com/users/monalisa/followers following_url: https://api.github.com/users/monalisa/following{/other_user} gists_url: https://api.github.com/users/monalisa/gists{/gist_id} starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/monalisa/subscriptions organizations_url: https://api.github.com/users/monalisa/orgs repos_url: https://api.github.com/users/monalisa/repos events_url: https://api.github.com/users/monalisa/events{/privacy} received_events_url: https://api.github.com/users/monalisa/received_events type: User site_admin: true push_protection_bypassed: true push_protection_bypassed_at: '2020-11-06T21:48:51Z' resolution_comment: Example comment - number: 1 created_at: '2020-11-06T18:18:30Z' url: https://api.github.com/repos/owner/repo/secret-scanning/alerts/1 html_url: https://github.com/owner/repo/security/secret-scanning/1 locations_url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/1/locations state: open resolution: null resolved_at: null resolved_by: null secret_type: mailchimp_api_key secret_type_display_name: Mailchimp API Key secret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2 repository: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 name: Hello-World full_name: octocat/Hello-World owner: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false private: false html_url: https://github.com/octocat/Hello-World description: This your first repo! fork: false url: https://api.github.com/repos/octocat/Hello-World archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads events_url: https://api.github.com/repos/octocat/Hello-World/events forks_url: https://api.github.com/repos/octocat/Hello-World/forks git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} languages_url: https://api.github.com/repos/octocat/Hello-World/languages merges_url: https://api.github.com/repos/octocat/Hello-World/merges milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription tags_url: https://api.github.com/repos/octocat/Hello-World/tags teams_url: https://api.github.com/repos/octocat/Hello-World/teams trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks push_protection_bypassed_by: null push_protection_bypassed: false push_protection_bypassed_at: null resolution_comment: null dependabot-alerts-for-repository: value: - number: 2 state: dismissed dependency: package: ecosystem: pip name: django manifest_path: path/to/requirements.txt scope: runtime security_advisory: ghsa_id: GHSA-rf4j-j272-fj86 cve_id: CVE-2018-6188 summary: Django allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive description: django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive. vulnerabilities: - package: ecosystem: pip name: django severity: high vulnerable_version_range: '>= 2.0.0, < 2.0.2' first_patched_version: identifier: 2.0.2 - package: ecosystem: pip name: django severity: high vulnerable_version_range: '>= 1.11.8, < 1.11.10' first_patched_version: identifier: 1.11.10 severity: high cvss: vector_string: CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N score: 7.5 cwes: - cwe_id: CWE-200 name: Exposure of Sensitive Information to an Unauthorized Actor identifiers: - type: GHSA value: GHSA-rf4j-j272-fj86 - type: CVE value: CVE-2018-6188 references: - url: https://nvd.nist.gov/vuln/detail/CVE-2018-6188 - url: https://github.com/advisories/GHSA-rf4j-j272-fj86 - url: https://usn.ubuntu.com/3559-1/ - url: https://www.djangoproject.com/weblog/2018/feb/01/security-releases/ - url: http://www.securitytracker.com/id/1040422 published_at: '2018-10-03T21:13:54Z' updated_at: '2022-04-26T18:35:37Z' withdrawn_at: '2022-04-26T18:35:37Z' security_vulnerability: package: ecosystem: pip name: django severity: high vulnerable_version_range: '>= 2.0.0, < 2.0.2' first_patched_version: identifier: 2.0.2 url: https://api.github.com/repos/octocat/hello-world/dependabot/alerts/2 html_url: https://github.com/octocat/hello-world/security/dependabot/2 created_at: '2022-06-15T07:43:03Z' updated_at: '2022-08-23T14:29:47Z' dismissed_at: '2022-08-23T14:29:47Z' dismissed_by: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false dismissed_reason: tolerable_risk dismissed_comment: This alert is accurate but we use a sanitizer. fixed_at: '2020-02-14T12:29:18Z' - number: 1 state: open dependency: package: ecosystem: pip name: ansible manifest_path: path/to/requirements.txt scope: runtime security_advisory: ghsa_id: GHSA-8f4m-hccc-8qph cve_id: CVE-2021-20191 summary: Insertion of Sensitive Information into Log File in ansible description: flaw was found in ansible. Credentials, such as secrets, are being disclosed in console log by default and not protected by no_log feature when using those modules. An attacker can take advantage of this information to steal those credentials. The highest threat from this vulnerability is to data confidentiality. vulnerabilities: - package: ecosystem: pip name: ansible severity: medium vulnerable_version_range: '>= 2.9.0, < 2.9.18' first_patched_version: identifier: 2.9.18 - package: ecosystem: pip name: ansible severity: medium vulnerable_version_range: < 2.8.19 first_patched_version: identifier: 2.8.19 - package: ecosystem: pip name: ansible severity: medium vulnerable_version_range: '>= 2.10.0, < 2.10.7' first_patched_version: identifier: 2.10.7 severity: medium cvss: vector_string: CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N score: 5.5 cwes: - cwe_id: CWE-532 name: Insertion of Sensitive Information into Log File identifiers: - type: GHSA value: GHSA-8f4m-hccc-8qph - type: CVE value: CVE-2021-20191 references: - url: https://nvd.nist.gov/vuln/detail/CVE-2021-20191 - url: https://access.redhat.com/security/cve/cve-2021-20191 - url: https://bugzilla.redhat.com/show_bug.cgi?id=1916813 published_at: '2021-06-01T17:38:00Z' updated_at: '2021-08-12T23:06:00Z' withdrawn_at: '2022-04-26T18:35:37Z' security_vulnerability: package: ecosystem: pip name: ansible severity: medium vulnerable_version_range: < 2.8.19 first_patched_version: identifier: 2.8.19 url: https://api.github.com/repos/octocat/hello-world/dependabot/alerts/1 html_url: https://github.com/octocat/hello-world/security/dependabot/1 created_at: '2022-06-14T15:21:52Z' updated_at: '2022-06-14T15:21:52Z' dismissed_at: '2020-02-14T12:29:18Z' dismissed_by: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false dismissed_reason: fix_started dismissed_comment: '' fixed_at: '2020-02-14T12:29:18Z' code-scanning-organization-alert-items: value: - number: 4 created_at: '2020-02-13T12:29:18Z' url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4 html_url: https://github.com/octocat/hello-world/code-scanning/4 state: open dismissed_by: null dismissed_at: null dismissed_reason: null dismissed_comment: null rule: id: js/zipslip severity: error tags: - security - external/cwe/cwe-022 description: Arbitrary file write during zip extraction name: js/zipslip tool: name: CodeQL guid: null version: 2.4.0 most_recent_instance: ref: refs/heads/main analysis_key: .github/workflows/codeql-analysis.yml:CodeQL-Build category: .github/workflows/codeql-analysis.yml:CodeQL-Build environment: '{}' state: open commit_sha: 39406e42cb832f683daa691dd652a8dc36ee8930 message: text: This path depends on a user-provided value. location: path: spec-main/api-session-spec.ts start_line: 917 end_line: 917 start_column: 7 end_column: 18 classifications: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4/instances repository: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 name: Hello-World full_name: octocat/Hello-World owner: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false private: false html_url: https://github.com/octocat/Hello-World description: This your first repo! fork: false url: https://api.github.com/repos/octocat/Hello-World archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads events_url: https://api.github.com/repos/octocat/Hello-World/events forks_url: https://api.github.com/repos/octocat/Hello-World/forks git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} languages_url: https://api.github.com/repos/octocat/Hello-World/languages merges_url: https://api.github.com/repos/octocat/Hello-World/merges milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription tags_url: https://api.github.com/repos/octocat/Hello-World/tags teams_url: https://api.github.com/repos/octocat/Hello-World/teams trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - number: 3 created_at: '2020-02-13T12:29:18Z' url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3 html_url: https://github.com/octocat/hello-world/code-scanning/3 state: dismissed dismissed_by: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false dismissed_at: '2020-02-14T12:29:18Z' dismissed_reason: false positive dismissed_comment: This alert is not actually correct, because there's a sanitizer included in the library. rule: id: js/zipslip severity: error tags: - security - external/cwe/cwe-022 description: Arbitrary file write during zip extraction name: js/zipslip tool: name: CodeQL guid: null version: 2.4.0 most_recent_instance: ref: refs/heads/main analysis_key: .github/workflows/codeql-analysis.yml:CodeQL-Build category: .github/workflows/codeql-analysis.yml:CodeQL-Build environment: '{}' state: open commit_sha: 39406e42cb832f683daa691dd652a8dc36ee8930 message: text: This path depends on a user-provided value. location: path: lib/ab12-gen.js start_line: 917 end_line: 917 start_column: 7 end_column: 18 classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances repository: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 name: Hello-World full_name: octocat/Hello-World owner: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false private: false html_url: https://github.com/octocat/Hello-World description: This your first repo! fork: false url: https://api.github.com/repos/octocat/Hello-World archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads events_url: https://api.github.com/repos/octocat/Hello-World/events forks_url: https://api.github.com/repos/octocat/Hello-World/forks git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} languages_url: https://api.github.com/repos/octocat/Hello-World/languages merges_url: https://api.github.com/repos/octocat/Hello-World/merges milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription tags_url: https://api.github.com/repos/octocat/Hello-World/tags teams_url: https://api.github.com/repos/octocat/Hello-World/teams trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks code-scanning-alert-instances: value: - ref: refs/heads/main analysis_key: .github/workflows/codeql-analysis.yml:CodeQL-Build environment: '' category: .github/workflows/codeql-analysis.yml:CodeQL-Build state: open fixed_at: '2020-02-14T12:29:18Z' commit_sha: 39406e42cb832f683daa691dd652a8dc36ee8930 message: text: This path depends on a user-provided value. location: path: lib/ab12-gen.js start_line: 917 end_line: 917 start_column: 7 end_column: 18 classifications: - library - ref: refs/pull/3740/merge analysis_key: .github/workflows/codeql-analysis.yml:CodeQL-Build environment: '' category: .github/workflows/codeql-analysis.yml:CodeQL-Build state: fixed fixed_at: '2020-02-14T12:29:18Z' commit_sha: b09da05606e27f463a2b49287684b4ae777092f2 message: text: This suffix check is missing a length comparison to correctly handle lastIndexOf returning -1. location: path: app/script.js start_line: 2 end_line: 2 start_column: 10 end_column: 50 classifications: - source secret-scanning-alert-open: value: number: 42 created_at: '2020-11-06T18:18:30Z' url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42 html_url: https://github.com/owner/private-repo/security/secret-scanning/42 locations_url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42/locations state: open secret_type: mailchimp_api_key secret_type_display_name: Mailchimp API Key secret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2 push_protection_bypassed: false headers: link: example: ; rel="next", ; rel="last" schema: type: string securitySchemes: bearerHttpAuthentication: description: Bearer Token type: http scheme: Bearer externalDocs: description: GitHub Enterprise Developer Docs url: https://docs.github.com/enterprise-server@3.9/rest/ x-webhooks: branch-protection-rule-created: post: summary: 'This event occurs when there is activity relating to branch protection rules. For more information, see "[About protected branches](https://docs.github.com/enterprise-server@3.9/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#branchprotectionrule) or "[Branch protection](https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission.' description: A branch protection rule was created. operationId: branch-protection-rule/created externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#branch_protection_rule parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-branch-protection-rule-created' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: branch_protection_rule supported-webhook-types: - repository - organization - app branch-protection-rule-deleted: post: summary: 'This event occurs when there is activity relating to branch protection rules. For more information, see "[About protected branches](https://docs.github.com/enterprise-server@3.9/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#branchprotectionrule) or "[Branch protection](https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission.' description: A branch protection rule was deleted. operationId: branch-protection-rule/deleted externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#branch_protection_rule parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-branch-protection-rule-deleted' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: branch_protection_rule supported-webhook-types: - repository - organization - app branch-protection-rule-edited: post: summary: 'This event occurs when there is activity relating to branch protection rules. For more information, see "[About protected branches](https://docs.github.com/enterprise-server@3.9/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#branchprotectionrule) or "[Branch protection](https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission.' description: A branch protection rule was edited. operationId: branch-protection-rule/edited externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#branch_protection_rule parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-branch-protection-rule-edited' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: branch_protection_rule supported-webhook-types: - repository - organization - app cache-sync: post: summary: This event occurs when a Git ref has been successfully synced to a cache replica. For more information, see "[About repository caching](https://docs.github.com/enterprise-server@3.9/admin/enterprise-management/caching-repositories/about-repository-caching)." operationId: cache-sync externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#cache_sync parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-cache-sync' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: cache_sync supported-webhook-types: - repository - organization - app check-run-completed: post: summary: 'This event occurs when there is activity relating to a check run. For information about check runs, see "[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-server@3.9/rest/checks/runs)" in the REST API documentation. For activity relating to check suites, use the `check-suite` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event. Repository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories. **Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.' description: A check run was completed, and a conclusion is available. operationId: check-run/completed externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#check_run parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-check-run-completed' examples: default: $ref: '#/components/examples/check-run-completed' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/webhook-check-run-completed-form-encoded' examples: default: $ref: '#/components/examples/check-run-completed-form-encoded' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false enabledForGitHubApps: true category: webhooks subcategory: check_run supported-webhook-types: - repository - organization - app check-run-created: post: summary: 'This event occurs when there is activity relating to a check run. For information about check runs, see "[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-server@3.9/rest/checks/runs)" in the REST API documentation. For activity relating to check suites, use the `check-suite` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event. Repository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories. **Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.' description: A new check run was created. operationId: check-run/created externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#check_run parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-check-run-created' examples: default: $ref: '#/components/examples/check-run-created' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/webhook-check-run-created-form-encoded' examples: default: $ref: '#/components/examples/check-run-created-form-encoded' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false enabledForGitHubApps: true category: webhooks subcategory: check_run supported-webhook-types: - repository - organization - app check-run-requested-action: post: summary: 'This event occurs when there is activity relating to a check run. For information about check runs, see "[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-server@3.9/rest/checks/runs)" in the REST API documentation. For activity relating to check suites, use the `check-suite` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event. Repository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories. **Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.' description: A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the `requested_action` payload. For more information, see "[Creating CI tests with the Checks API](https://docs.github.com/enterprise-server@3.9/developers/apps/guides/creating-ci-tests-with-the-checks-api)." operationId: check-run/requested-action externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#check_run parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-check-run-requested-action' examples: default: $ref: '#/components/examples/check-run-requested-action' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/webhook-check-run-requested-action-form-encoded' examples: default: $ref: '#/components/examples/check-run-requested-action-form-encoded' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false enabledForGitHubApps: true category: webhooks subcategory: check_run supported-webhook-types: - repository - organization - app check-run-rerequested: post: summary: 'This event occurs when there is activity relating to a check run. For information about check runs, see "[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-server@3.9/rest/checks/runs)" in the REST API documentation. For activity relating to check suites, use the `check-suite` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event. Repository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories. **Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.' description: Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the `rerequested` payload. operationId: check-run/rerequested externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#check_run parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-check-run-rerequested' examples: default: $ref: '#/components/examples/check-run-rerequested' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/webhook-check-run-rerequested-form-encoded' examples: default: $ref: '#/components/examples/check-run-rerequested-form-encoded' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false enabledForGitHubApps: true category: webhooks subcategory: check_run supported-webhook-types: - repository - organization - app check-suite-completed: post: summary: 'This event occurs when there is activity relating to a check suite. For information about check suites, see "[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/enterprise-server@3.9/rest/checks/suites)" in the REST API documentation. For activity relating to check runs, use the `check_run` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event. Repository and organization webhooks only receive payloads for the `completed` event types in repositories. **Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.' description: All check runs in a check suite have completed, and a conclusion is available. operationId: check-suite/completed externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#check_suite parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-check-suite-completed' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: check_suite supported-webhook-types: - repository - organization - app check-suite-requested: post: summary: 'This event occurs when there is activity relating to a check suite. For information about check suites, see "[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/enterprise-server@3.9/rest/checks/suites)" in the REST API documentation. For activity relating to check runs, use the `check_run` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event. Repository and organization webhooks only receive payloads for the `completed` event types in repositories. **Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.' description: Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see [the GraphQL API documentation for creating a check run](https://docs.github.com/enterprise-server@3.9/graphql/reference/mutations#createcheckrun) or "[Create a check run](https://docs.github.com/enterprise-server@3.9/rest/checks/runs#create-a-check-run)" in the REST API documentation. operationId: check-suite/requested externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#check_suite parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-check-suite-requested' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: check_suite supported-webhook-types: - repository - organization - app check-suite-rerequested: post: summary: 'This event occurs when there is activity relating to a check suite. For information about check suites, see "[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/enterprise-server@3.9/rest/checks/suites)" in the REST API documentation. For activity relating to check runs, use the `check_run` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event. Repository and organization webhooks only receive payloads for the `completed` event types in repositories. **Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.' description: Someone requested to re-run the check runs in a check suite. For more information, see [the GraphQL API documentation for creating a check suite](https://docs.github.com/enterprise-server@3.9/graphql/reference/mutations#createchecksuite) or "[Create a check suite](https://docs.github.com/enterprise-server@3.9/rest/checks/suites#create-a-check-suite)" in the REST API documentation. operationId: check-suite/rerequested externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#check_suite parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-check-suite-rerequested' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: check_suite supported-webhook-types: - repository - organization - app code-scanning-alert-appeared-in-branch: post: summary: 'This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-server@3.9/rest/code-scanning)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission.' description: A previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert. operationId: code-scanning-alert/appeared-in-branch externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#code_scanning_alert parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-code-scanning-alert-appeared-in-branch' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: code_scanning_alert supported-webhook-types: - repository - organization - app code-scanning-alert-closed-by-user: post: summary: 'This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-server@3.9/rest/code-scanning)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission.' description: Someone closed a code scanning alert. operationId: code-scanning-alert/closed-by-user externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#code_scanning_alert parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-code-scanning-alert-closed-by-user' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: code_scanning_alert supported-webhook-types: - repository - organization - app code-scanning-alert-created: post: summary: 'This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-server@3.9/rest/code-scanning)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission.' description: A code scanning alert was created in a repository. operationId: code-scanning-alert/created externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#code_scanning_alert parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-code-scanning-alert-created' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: code_scanning_alert supported-webhook-types: - repository - organization - app code-scanning-alert-fixed: post: summary: 'This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-server@3.9/rest/code-scanning)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission.' description: A code scanning alert was fixed in a branch by a commit. operationId: code-scanning-alert/fixed externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#code_scanning_alert parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-code-scanning-alert-fixed' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: code_scanning_alert supported-webhook-types: - repository - organization - app code-scanning-alert-reopened: post: summary: 'This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-server@3.9/rest/code-scanning)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission.' description: A previously fixed code scanning alert reappeared in a branch. operationId: code-scanning-alert/reopened externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#code_scanning_alert parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-code-scanning-alert-reopened' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: code_scanning_alert supported-webhook-types: - repository - organization - app code-scanning-alert-reopened-by-user: post: summary: 'This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-server@3.9/rest/code-scanning)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission.' description: Someone reopened a code scanning alert. operationId: code-scanning-alert/reopened-by-user externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#code_scanning_alert parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-code-scanning-alert-reopened-by-user' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: code_scanning_alert supported-webhook-types: - repository - organization - app commit-comment-created: post: summary: 'This event occurs when there is activity relating to commit comments. For more information about commit comments, see "[Commenting on a pull request](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request)." For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#commitcomment) or "[Commit comments](https://docs.github.com/enterprise-server@3.9/rest/commits/comments)" in the REST API documentation. For activity relating to comments on pull request reviews, use the `pull_request_review_comment` event. For activity relating to issue comments, use the `issue_comment` event. For activity relating to discussion comments, use the `discussion_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.' description: Someone commented on a commit. operationId: commit-comment/created externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#commit_comment parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-commit-comment-created' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: commit_comment supported-webhook-types: - repository - organization - app create: post: summary: 'This event occurs when a Git branch or tag is created. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. **Notes**: - This event will not occur when more than three tags are created at once. - Payloads are capped at 25 MB. If an event generates a larger payload, GitHub will not deliver a payload for that webhook event. This may happen, for example, if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery.' operationId: create externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#create parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-create' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: create supported-webhook-types: - repository - organization - app delete: post: summary: 'This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including branch and tag deletions, use the [`push`](#push) webhook event. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. **Note**: This event will not occur when more than three tags are deleted at once.' operationId: delete externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#delete parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-delete' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: delete supported-webhook-types: - repository - organization - app dependabot-alert-created: post: summary: 'This event occurs when there is activity relating to Dependabot alerts. For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-server@3.9/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-server@3.9/rest/dependabot/alerts)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. **Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.' description: A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable. operationId: dependabot-alert/created externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#dependabot_alert parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-dependabot-alert-created' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: dependabot_alert supported-webhook-types: - repository - organization - app dependabot-alert-dismissed: post: summary: 'This event occurs when there is activity relating to Dependabot alerts. For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-server@3.9/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-server@3.9/rest/dependabot/alerts)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. **Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.' description: A Dependabot alert was manually closed. operationId: dependabot-alert/dismissed externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#dependabot_alert parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-dependabot-alert-dismissed' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: dependabot_alert supported-webhook-types: - repository - organization - app dependabot-alert-fixed: post: summary: 'This event occurs when there is activity relating to Dependabot alerts. For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-server@3.9/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-server@3.9/rest/dependabot/alerts)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. **Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.' description: A manifest file change removed a vulnerability. operationId: dependabot-alert/fixed externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#dependabot_alert parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-dependabot-alert-fixed' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: dependabot_alert supported-webhook-types: - repository - organization - app dependabot-alert-reintroduced: post: summary: 'This event occurs when there is activity relating to Dependabot alerts. For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-server@3.9/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-server@3.9/rest/dependabot/alerts)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. **Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.' description: A manifest file change introduced a vulnerable dependency that had previously been fixed. operationId: dependabot-alert/reintroduced externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#dependabot_alert parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-dependabot-alert-reintroduced' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: dependabot_alert supported-webhook-types: - repository - organization - app dependabot-alert-reopened: post: summary: 'This event occurs when there is activity relating to Dependabot alerts. For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-server@3.9/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-server@3.9/rest/dependabot/alerts)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. **Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.' description: A Dependabot alert was manually reopened. operationId: dependabot-alert/reopened externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#dependabot_alert parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-dependabot-alert-reopened' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: dependabot_alert supported-webhook-types: - repository - organization - app deploy-key-created: post: summary: 'This event occurs when there is activity relating to deploy keys. For more information, see "[Managing deploy keys](https://docs.github.com/enterprise-server@3.9/developers/overview/managing-deploy-keys)." For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#deploykey) or "[Deploy keys](https://docs.github.com/enterprise-server@3.9/rest/deploy-keys)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission.' description: A deploy key was created. operationId: deploy-key/created externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#deploy_key parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-deploy-key-created' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: deploy_key supported-webhook-types: - repository - organization - app deploy-key-deleted: post: summary: 'This event occurs when there is activity relating to deploy keys. For more information, see "[Managing deploy keys](https://docs.github.com/enterprise-server@3.9/developers/overview/managing-deploy-keys)." For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#deploykey) or "[Deploy keys](https://docs.github.com/enterprise-server@3.9/rest/deploy-keys)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission.' description: A deploy key was deleted. operationId: deploy-key/deleted externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#deploy_key parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-deploy-key-deleted' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: deploy_key supported-webhook-types: - repository - organization - app deployment-created: post: summary: 'This event occurs when there is activity relating to deployments. For more information, see "[About deployments](https://docs.github.com/enterprise-server@3.9/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-server@3.9/rest/deployments/deployments)" in the REST API documentation. For activity relating to deployment status, use the `deployment_status` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission.' description: A deployment was created. operationId: deployment/created externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#deployment parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-deployment-created' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: deployment supported-webhook-types: - repository - organization - app deployment-review-approved: post: summary: 'This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/enterprise-server@3.9/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-server@3.9/rest/deployments/deployments)" in the REST API documentation. For activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission.' description: A deployment review was approved. operationId: deployment-review/approved externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#deployment_review parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-deployment-review-approved' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: deployment_review supported-webhook-types: - app deployment-review-rejected: post: summary: 'This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/enterprise-server@3.9/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-server@3.9/rest/deployments/deployments)" in the REST API documentation. For activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission.' description: A deployment review was rejected. operationId: deployment-review/rejected externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#deployment_review parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-deployment-review-rejected' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: deployment_review supported-webhook-types: - app deployment-review-requested: post: summary: 'This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/enterprise-server@3.9/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-server@3.9/rest/deployments/deployments)" in the REST API documentation. For activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission.' description: A deployment review was requested. operationId: deployment-review/requested externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#deployment_review parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-deployment-review-requested' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: deployment_review supported-webhook-types: - app deployment-status-created: post: summary: 'This event occurs when there is activity relating to deployment statuses. For more information, see "[About deployments](https://docs.github.com/enterprise-server@3.9/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-server@3.9/rest/deployments/deployments)" in the REST API documentation. For activity relating to deployment creation, use the `deployment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission.' description: A new deployment status was created. operationId: deployment-status/created externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#deployment_status parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-deployment-status-created' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: deployment_status supported-webhook-types: - repository - organization - app discussion-answered: post: summary: 'This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.' description: A comment on the discussion was marked as the answer. operationId: discussion/answered externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-discussion-answered' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: discussion supported-webhook-types: - repository - organization - app discussion-category-changed: post: summary: 'This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.' description: The category of a discussion was changed. operationId: discussion/category-changed externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-discussion-category-changed' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: discussion supported-webhook-types: - repository - organization - app discussion-closed: post: summary: 'This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.' description: A discussion was closed. operationId: discussion/closed externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: discussions schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.9.0 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-discussion-closed' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: discussion supported-webhook-types: - repository - organization - app discussion-comment-created: post: summary: 'This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion). For activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.' description: A comment on a discussion was created. operationId: discussion-comment/created externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion_comment parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-discussion-comment-created' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: discussion_comment supported-webhook-types: - repository - organization - app discussion-comment-deleted: post: summary: 'This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion). For activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.' description: A comment on a discussion was deleted. operationId: discussion-comment/deleted externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion_comment parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-discussion-comment-deleted' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: discussion_comment supported-webhook-types: - repository - organization - app discussion-comment-edited: post: summary: 'This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion). For activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.' description: A comment on a discussion was edited. operationId: discussion-comment/edited externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion_comment parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-discussion-comment-edited' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: discussion_comment supported-webhook-types: - repository - organization - app discussion-created: post: summary: 'This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.' description: A discussion was created. operationId: discussion/created externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-discussion-created' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: discussion supported-webhook-types: - repository - organization - app discussion-deleted: post: summary: 'This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.' description: A discussion was deleted. operationId: discussion/deleted externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-discussion-deleted' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: discussion supported-webhook-types: - repository - organization - app discussion-edited: post: summary: 'This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.' description: The title or body on a discussion was edited, or the category of the discussion was changed. operationId: discussion/edited externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-discussion-edited' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: discussion supported-webhook-types: - repository - organization - app discussion-labeled: post: summary: 'This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.' description: A label was added to a discussion. operationId: discussion/labeled externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-discussion-labeled' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: discussion supported-webhook-types: - repository - organization - app discussion-locked: post: summary: 'This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.' description: A discussion was locked. operationId: discussion/locked externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-discussion-locked' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: discussion supported-webhook-types: - repository - organization - app discussion-pinned: post: summary: 'This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.' description: A discussion was pinned. operationId: discussion/pinned externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-discussion-pinned' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: discussion supported-webhook-types: - repository - organization - app discussion-reopened: post: summary: 'This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.' description: A discussion was reopened. operationId: discussion/reopened externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: discussions schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.9.0 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-discussion-reopened' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: discussion supported-webhook-types: - repository - organization - app discussion-transferred: post: summary: 'This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.' description: A discussion was transferred to another repository. operationId: discussion/transferred externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-discussion-transferred' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: discussion supported-webhook-types: - repository - organization - app discussion-unanswered: post: summary: 'This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.' description: A comment on the discussion was unmarked as the answer. operationId: discussion/unanswered externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-discussion-unanswered' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: discussion supported-webhook-types: - repository - organization - app discussion-unlabeled: post: summary: 'This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.' description: A label was removed from a discussion. operationId: discussion/unlabeled externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-discussion-unlabeled' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: discussion supported-webhook-types: - repository - organization - app discussion-unlocked: post: summary: 'This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.' description: A discussion was unlocked. operationId: discussion/unlocked externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-discussion-unlocked' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: discussion supported-webhook-types: - repository - organization - app discussion-unpinned: post: summary: 'This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. **Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.' description: A discussion was unpinned. operationId: discussion/unpinned externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-discussion-unpinned' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: discussion supported-webhook-types: - repository - organization - app enterprise-anonymous-access-disabled: post: summary: This event occurs when there is activity relating to anonymous Git read access in an enterprise. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.9/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access)." description: Anonymous Git read access was disabled. operationId: enterprise/anonymous-access-disabled externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#enterprise parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-enterprise-anonymous-access-disabled' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: enterprise supported-webhook-types: - business enterprise-anonymous-access-enabled: post: summary: This event occurs when there is activity relating to anonymous Git read access in an enterprise. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.9/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access)." description: Anonymous Git read access was enabled. operationId: enterprise/anonymous-access-enabled externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#enterprise parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-enterprise-anonymous-access-enabled' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: enterprise supported-webhook-types: - business fork: post: summary: 'This event occurs when someone forks a repository. For more information, see "[Fork a repo](https://docs.github.com/enterprise-server@3.9/get-started/quickstart/fork-a-repo)." For information about the API to manage forks, see "[Forks](https://docs.github.com/enterprise-server@3.9/rest/repos/forks)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.' operationId: fork externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#fork parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-fork' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: fork supported-webhook-types: - business - repository - organization - app github-app-authorization-revoked: post: summary: 'This event occurs when a user revokes their authorization of a GitHub App. For more information, see "[About apps](https://docs.github.com/enterprise-server@3.9/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the API to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-server@3.9/rest/apps)" in the REST API documentation. A GitHub App receives this webhook by default and cannot unsubscribe from this event. Anyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the `401 Bad Credentials` error. For details about requests with a user access token, which require GitHub App authorization, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/enterprise-server@3.9/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)."' description: Someone revoked their authorization of a GitHub App. operationId: github-app-authorization/revoked externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#github_app_authorization parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-github-app-authorization-revoked' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: github_app_authorization supported-webhook-types: - app gollum: post: summary: 'This event occurs when someone creates or updates a wiki page. For more information, see "[About wikis](https://docs.github.com/enterprise-server@3.9/communities/documenting-your-project-with-wikis/about-wikis)." To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.' operationId: gollum externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#gollum parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-gollum' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: gollum supported-webhook-types: - repository - organization - app installation-created: post: summary: 'This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-server@3.9/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-server@3.9/rest/apps)" in the REST API documentation.' description: Someone installed a GitHub App on a user or organization account. operationId: installation/created externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#installation parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-installation-created' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: installation supported-webhook-types: - app installation-deleted: post: summary: 'This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-server@3.9/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-server@3.9/rest/apps)" in the REST API documentation.' description: Someone uninstalled a GitHub App from their user or organization account. operationId: installation/deleted externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#installation parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-installation-deleted' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: installation supported-webhook-types: - app installation-new-permissions-accepted: post: summary: 'This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-server@3.9/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-server@3.9/rest/apps)" in the REST API documentation.' description: Someone granted new permissions to a GitHub App. operationId: installation/new-permissions-accepted externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#installation parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-installation-new-permissions-accepted' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: installation supported-webhook-types: - app installation-repositories-added: post: summary: 'This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-server@3.9/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-server@3.9/rest/apps)" in the REST API documentation.' description: A GitHub App installation was granted access to one or more repositories. operationId: installation-repositories/added externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#installation_repositories parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-installation-repositories-added' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: installation_repositories supported-webhook-types: - app installation-repositories-removed: post: summary: 'This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-server@3.9/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-server@3.9/rest/apps)" in the REST API documentation.' description: Access to one or more repositories was revoked for a GitHub App installation. operationId: installation-repositories/removed externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#installation_repositories parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-installation-repositories-removed' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: installation_repositories supported-webhook-types: - app installation-suspend: post: summary: 'This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-server@3.9/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-server@3.9/rest/apps)" in the REST API documentation.' description: Someone blocked access by a GitHub App to their user or organization account. operationId: installation/suspend externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#installation parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-installation-suspend' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: installation supported-webhook-types: - app installation-target-renamed: post: summary: This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see "[About apps](https://docs.github.com/enterprise-server@3.9/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-server@3.9/rest/apps)" in the REST API documentation. description: Somebody renamed the user or organization account that a GitHub App is installed on. operationId: installation-target/renamed externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#installation_target parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-installation-target-renamed' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: installation_target supported-webhook-types: - app installation-unsuspend: post: summary: 'This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-server@3.9/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-server@3.9/rest/apps)" in the REST API documentation.' description: A GitHub App that was blocked from accessing a user or organization account was given access the account again. operationId: installation/unsuspend externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#installation parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-installation-unsuspend' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: installation supported-webhook-types: - app issue-comment-created: post: summary: 'This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-server@3.9/rest/issues/comments)" in the REST API documentation. For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/enterprise-server@3.9/rest/guides/working-with-comments)." To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.' description: A comment on an issue or pull request was created. operationId: issue-comment/created externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issue_comment parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-issue-comment-created' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: issue_comment supported-webhook-types: - repository - organization - app issue-comment-deleted: post: summary: 'This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-server@3.9/rest/issues/comments)" in the REST API documentation. For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/enterprise-server@3.9/rest/guides/working-with-comments)." To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.' description: A comment on an issue or pull request was deleted. operationId: issue-comment/deleted externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issue_comment parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-issue-comment-deleted' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: issue_comment supported-webhook-types: - repository - organization - app issue-comment-edited: post: summary: 'This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-server@3.9/rest/issues/comments)" in the REST API documentation. For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/enterprise-server@3.9/rest/guides/working-with-comments)." To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.' description: A comment on an issue or pull request was edited. operationId: issue-comment/edited externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issue_comment parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-issue-comment-edited' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: issue_comment supported-webhook-types: - repository - organization - app issues-assigned: post: summary: 'This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.' description: An issue was assigned to a user. operationId: issues/assigned externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-issues-assigned' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: issues supported-webhook-types: - repository - organization - app issues-closed: post: summary: 'This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.' description: An issue was closed. operationId: issues/closed externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-issues-closed' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: issues supported-webhook-types: - repository - organization - app issues-deleted: post: summary: 'This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.' description: An issue was deleted. operationId: issues/deleted externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-issues-deleted' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: issues supported-webhook-types: - repository - organization - app issues-demilestoned: post: summary: 'This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.' description: An issue was removed from a milestone. operationId: issues/demilestoned externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-issues-demilestoned' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: issues supported-webhook-types: - repository - organization - app issues-edited: post: summary: 'This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.' description: The title or body on an issue was edited. operationId: issues/edited externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-issues-edited' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: issues supported-webhook-types: - repository - organization - app issues-labeled: post: summary: 'This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.' description: A label was added to an issue. operationId: issues/labeled externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-issues-labeled' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: issues supported-webhook-types: - repository - organization - app issues-locked: post: summary: 'This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.' description: Conversation on an issue was locked. For more information, see "[Locking conversations](https://docs.github.com/enterprise-server@3.9/communities/moderating-comments-and-conversations/locking-conversations)." operationId: issues/locked externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-issues-locked' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: issues supported-webhook-types: - repository - organization - app issues-milestoned: post: summary: 'This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.' description: An issue was added to a milestone. operationId: issues/milestoned externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-issues-milestoned' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: issues supported-webhook-types: - repository - organization - app issues-opened: post: summary: 'This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.' description: An issue was created. When a closed issue is reopened, the action will be `reopened` instead. operationId: issues/opened externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-issues-opened' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: issues supported-webhook-types: - repository - organization - app issues-pinned: post: summary: 'This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.' description: An issue was pinned to a repository. For more information, see "[Pinning an issue to your repository](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." operationId: issues/pinned externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-issues-pinned' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: issues supported-webhook-types: - repository - organization - app issues-reopened: post: summary: 'This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.' description: A closed issue was reopened. operationId: issues/reopened externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-issues-reopened' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: issues supported-webhook-types: - repository - organization - app issues-transferred: post: summary: 'This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.' description: An issue was transferred to another repository. For more information, see "[Transferring an issue to another repository](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository)." operationId: issues/transferred externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-issues-transferred' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: issues supported-webhook-types: - repository - organization - app issues-unassigned: post: summary: 'This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.' description: A user was unassigned from an issue. operationId: issues/unassigned externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-issues-unassigned' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: issues supported-webhook-types: - repository - organization - app issues-unlabeled: post: summary: 'This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.' description: A label was removed from an issue. operationId: issues/unlabeled externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-issues-unlabeled' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: issues supported-webhook-types: - repository - organization - app issues-unlocked: post: summary: 'This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.' description: Conversation on an issue was locked. For more information, see "[Locking conversations](https://docs.github.com/enterprise-server@3.9/communities/moderating-comments-and-conversations/locking-conversations)." operationId: issues/unlocked externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-issues-unlocked' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: issues supported-webhook-types: - repository - organization - app issues-unpinned: post: summary: 'This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.' description: An issue was unpinned from a repository. For more information, see "[Pinning an issue to your repository](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." operationId: issues/unpinned externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-issues-unpinned' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: issues supported-webhook-types: - repository - organization - app label-created: post: summary: 'This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/enterprise-server@3.9/issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#label) or "[Labels](https://docs.github.com/enterprise-server@3.9/rest/issues/labels)" in the REST API documentation. If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.' description: A label was created. operationId: label/created externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#label parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-label-created' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: label supported-webhook-types: - repository - organization - app label-deleted: post: summary: 'This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/enterprise-server@3.9/issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#label) or "[Labels](https://docs.github.com/enterprise-server@3.9/rest/issues/labels)" in the REST API documentation. If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.' description: A label was deleted. operationId: label/deleted externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#label parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-label-deleted' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: label supported-webhook-types: - repository - organization - app label-edited: post: summary: 'This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/enterprise-server@3.9/issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#label) or "[Labels](https://docs.github.com/enterprise-server@3.9/rest/issues/labels)" in the REST API documentation. If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.' description: A label's name, description, or color was changed. operationId: label/edited externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#label parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-label-edited' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: label supported-webhook-types: - repository - organization - app member-added: post: summary: 'This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/enterprise-server@3.9/rest/collaborators/collaborators)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.' description: A GitHub user accepted an invitation to a repository. operationId: member/added externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#member parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-member-added' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: member supported-webhook-types: - business - repository - organization - app member-edited: post: summary: 'This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/enterprise-server@3.9/rest/collaborators/collaborators)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.' description: Permissions were changed for a collaborator on a repository. operationId: member/edited externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#member parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-member-edited' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: member supported-webhook-types: - business - repository - organization - app member-removed: post: summary: 'This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/enterprise-server@3.9/rest/collaborators/collaborators)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.' description: A collaborator was removed from a repository. operationId: member/removed externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#member parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-member-removed' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: member supported-webhook-types: - business - repository - organization - app membership-added: post: summary: 'This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/enterprise-server@3.9/organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#team) or "[Team members](https://docs.github.com/enterprise-server@3.9/rest/teams/members)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.' description: An organization member was added to a team. operationId: membership/added externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#membership parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-membership-added' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: membership supported-webhook-types: - organization - business - app membership-removed: post: summary: 'This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/enterprise-server@3.9/organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#team) or "[Team members](https://docs.github.com/enterprise-server@3.9/rest/teams/members)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.' description: An organization member was removed from a team. operationId: membership/removed externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#membership parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-membership-removed' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: membership supported-webhook-types: - organization - business - app meta-deleted: post: summary: 'This event occurs when there is activity relating to a webhook itself. To subscribe to this event, a GitHub App must have at least read-level access for the "Meta" app permission.' description: The webhook was deleted. operationId: meta/deleted externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#meta parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-meta-deleted' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: meta supported-webhook-types: - marketplace - business - repository - organization - app milestone-closed: post: summary: 'This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-server@3.9/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-server@3.9/rest/issues/milestones)" in the REST API documentation. If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions.' description: A milestone was closed. operationId: milestone/closed externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#milestone parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-milestone-closed' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: milestone supported-webhook-types: - repository - organization - app milestone-created: post: summary: 'This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-server@3.9/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-server@3.9/rest/issues/milestones)" in the REST API documentation. If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions.' description: A milestone was created. operationId: milestone/created externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#milestone parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-milestone-created' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: milestone supported-webhook-types: - repository - organization - app milestone-deleted: post: summary: 'This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-server@3.9/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-server@3.9/rest/issues/milestones)" in the REST API documentation. If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions.' description: A milestone was deleted. operationId: milestone/deleted externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#milestone parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-milestone-deleted' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: milestone supported-webhook-types: - repository - organization - app milestone-edited: post: summary: 'This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-server@3.9/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-server@3.9/rest/issues/milestones)" in the REST API documentation. If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions.' description: A milestone was edited. operationId: milestone/edited externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#milestone parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-milestone-edited' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: milestone supported-webhook-types: - repository - organization - app milestone-opened: post: summary: 'This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-server@3.9/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-server@3.9/rest/issues/milestones)" in the REST API documentation. If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions.' description: A milestone was opened. operationId: milestone/opened externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#milestone parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-milestone-opened' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: milestone supported-webhook-types: - repository - organization - app organization-deleted: post: summary: 'This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/enterprise-server@3.9/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-server@3.9/rest/orgs)" in the REST API documentation. If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.' description: An organization was deleted. operationId: organization/deleted externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#organization parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-organization-deleted' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: organization supported-webhook-types: - organization - business - app organization-member-added: post: summary: 'This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/enterprise-server@3.9/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-server@3.9/rest/orgs)" in the REST API documentation. If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.' description: A member accepted an invitation to join an organization. operationId: organization/member-added externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#organization parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-organization-member-added' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: organization supported-webhook-types: - organization - business - app organization-member-invited: post: summary: 'This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/enterprise-server@3.9/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-server@3.9/rest/orgs)" in the REST API documentation. If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.' description: A member was invited to join the organization. operationId: organization/member-invited externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#organization parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-organization-member-invited' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: organization supported-webhook-types: - organization - business - app organization-member-removed: post: summary: 'This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/enterprise-server@3.9/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-server@3.9/rest/orgs)" in the REST API documentation. If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.' description: A member was removed from the organization. operationId: organization/member-removed externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#organization parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-organization-member-removed' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: organization supported-webhook-types: - organization - business - app organization-renamed: post: summary: 'This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/enterprise-server@3.9/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-server@3.9/rest/orgs)" in the REST API documentation. If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.' description: The name of an organization was changed. operationId: organization/renamed externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#organization parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-organization-renamed' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: organization supported-webhook-types: - organization - business - app package-published: post: summary: 'This event occurs when there is activity relating to GitHub Packages. For more information, see "[Introduction to GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#package) or "[Packages](https://docs.github.com/enterprise-server@3.9/rest/packages)" in the REST API documentation. To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission.' description: A package was published to a registry. operationId: package/published externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#package parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-package-published' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: package supported-webhook-types: - repository - organization - app package-updated: post: summary: 'This event occurs when there is activity relating to GitHub Packages. For more information, see "[Introduction to GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#package) or "[Packages](https://docs.github.com/enterprise-server@3.9/rest/packages)" in the REST API documentation. To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission.' description: A previously published package was updated. operationId: package/updated externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#package parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-package-updated' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: package supported-webhook-types: - repository - organization - app page-build: post: summary: 'This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see "[Configuring a publishing source for your GitHub Pages site](https://docs.github.com/enterprise-server@3.9/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)." For information about the API to manage GitHub Pages, see "[Pages](https://docs.github.com/enterprise-server@3.9/rest/pages)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Pages" repository permission.' operationId: page-build externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#page_build parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-page-build' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: page_build supported-webhook-types: - repository - organization - app ping: post: summary: This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly. operationId: ping externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#ping parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-ping' examples: default: $ref: '#/components/examples/ping' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/webhook-ping-form-encoded' examples: default: $ref: '#/components/examples/ping-form-encoded' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false enabledForGitHubApps: true category: webhooks subcategory: ping supported-webhook-types: - repository - organization - app - business - marketplace project-card-converted: post: summary: 'This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-server@3.9/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.9/rest/projects)" in the REST API documentation. For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission.' description: A note in a project (classic) was converted to an issue. operationId: project-card/converted externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#project_card parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-project-card-converted' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: project_card supported-webhook-types: - repository - organization - app project-card-created: post: summary: 'This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-server@3.9/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.9/rest/projects)" in the REST API documentation. For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission.' description: A card was added to a project (classic). operationId: project-card/created externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#project_card parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-project-card-created' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: project_card supported-webhook-types: - repository - organization - app project-card-deleted: post: summary: 'This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-server@3.9/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.9/rest/projects)" in the REST API documentation. For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission.' description: A card on a project (classic) was deleted. operationId: project-card/deleted externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#project_card parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-project-card-deleted' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: project_card supported-webhook-types: - repository - organization - app project-card-edited: post: summary: 'This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-server@3.9/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.9/rest/projects)" in the REST API documentation. For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission.' description: A note on a project (classic) was edited. operationId: project-card/edited externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#project_card parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-project-card-edited' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: project_card supported-webhook-types: - repository - organization - app project-card-moved: post: summary: 'This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-server@3.9/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.9/rest/projects)" in the REST API documentation. For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission.' description: A card on a project (classic) was moved to another column or to another position in its column. operationId: project-card/moved externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#project_card parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-project-card-moved' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: project_card supported-webhook-types: - repository - organization - app project-closed: post: summary: 'This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-server@3.9/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.9/rest/projects)" in the REST API documentation. For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission.' description: A project (classic) was closed. operationId: project/closed externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#project parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-project-closed' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: project supported-webhook-types: - repository - organization - app project-column-created: post: summary: 'This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-server@3.9/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.9/rest/projects)" in the REST API documentation. For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission.' description: A column was added to a project (classic). operationId: project-column/created externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#project_column parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-project-column-created' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: project_column supported-webhook-types: - repository - organization - app project-column-deleted: post: summary: 'This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-server@3.9/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.9/rest/projects)" in the REST API documentation. For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission.' description: A column was deleted from a project (classic). operationId: project-column/deleted externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#project_column parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-project-column-deleted' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: project_column supported-webhook-types: - repository - organization - app project-column-edited: post: summary: 'This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-server@3.9/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.9/rest/projects)" in the REST API documentation. For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission.' description: The name of a column on a project (classic) was changed. operationId: project-column/edited externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#project_column parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-project-column-edited' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: project_column supported-webhook-types: - repository - organization - app project-column-moved: post: summary: 'This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-server@3.9/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.9/rest/projects)" in the REST API documentation. For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission.' description: A column was moved to a new position on a project (classic). operationId: project-column/moved externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#project_column parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-project-column-moved' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: project_column supported-webhook-types: - repository - organization - app project-created: post: summary: 'This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-server@3.9/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.9/rest/projects)" in the REST API documentation. For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission.' description: A project (classic) was created. operationId: project/created externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#project parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-project-created' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: project supported-webhook-types: - repository - organization - app project-deleted: post: summary: 'This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-server@3.9/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.9/rest/projects)" in the REST API documentation. For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission.' description: A project (classic) was deleted. operationId: project/deleted externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#project parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-project-deleted' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: project supported-webhook-types: - repository - organization - app project-edited: post: summary: 'This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-server@3.9/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.9/rest/projects)" in the REST API documentation. For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission.' description: The name or description of a project (classic) was changed. operationId: project/edited externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#project parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-project-edited' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: project supported-webhook-types: - repository - organization - app project-reopened: post: summary: 'This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-server@3.9/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.9/rest/projects)" in the REST API documentation. For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission.' description: A project (classic) was closed. operationId: project/reopened externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#project parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-project-reopened' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: project supported-webhook-types: - repository - organization - app projects-v2-closed: post: summary: 'This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-server@3.9/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#projectv2). For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).' description: A project in the organization was closed. operationId: projects-v2/closed externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#projects_v2 parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: project-v2 schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-projects-v2-project-closed' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false enabledForGitHubApps: true category: webhooks subcategory: projects_v2 supported-webhook-types: - organization projects-v2-created: post: summary: 'This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-server@3.9/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#projectv2). For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).' description: A project in the organization was created. operationId: projects-v2/created externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#projects_v2 parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: project-v2 schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-projects-v2-project-created' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false enabledForGitHubApps: true category: webhooks subcategory: projects_v2 supported-webhook-types: - organization projects-v2-deleted: post: summary: 'This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-server@3.9/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#projectv2). For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).' description: A project in the organization was deleted. operationId: projects-v2/deleted externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#projects_v2 parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: project-v2 schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-projects-v2-project-deleted' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false enabledForGitHubApps: true category: webhooks subcategory: projects_v2 supported-webhook-types: - organization projects-v2-edited: post: summary: 'This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-server@3.9/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#projectv2). For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).' description: The title, description, or README of a project in the organization was changed. operationId: projects-v2/edited externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#projects_v2 parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: project-v2 schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-projects-v2-project-edited' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false enabledForGitHubApps: true category: webhooks subcategory: projects_v2 supported-webhook-types: - organization projects-v2-item-archived: post: summary: 'This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-server@3.9/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#projectv2item). For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).' description: An item on an organization project was archived. For more information, see "[Archiving items from your project](https://docs.github.com/enterprise-server@3.9/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project)." operationId: projects-v2-item/archived externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: project-v2-item schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-projects-v2-item-archived' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false enabledForGitHubApps: true category: webhooks subcategory: projects_v2_item supported-webhook-types: - organization projects-v2-item-converted: post: summary: 'This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-server@3.9/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#projectv2item). For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).' description: A draft issue in an organization project was converted to an issue. operationId: projects-v2-item/converted externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: project-v2-item schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-projects-v2-item-converted' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false enabledForGitHubApps: true category: webhooks subcategory: projects_v2_item supported-webhook-types: - organization projects-v2-item-created: post: summary: 'This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-server@3.9/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#projectv2item). For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).' description: An item was added to a project in the organization. operationId: projects-v2-item/created externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: project-v2-item schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-projects-v2-item-created' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false enabledForGitHubApps: true category: webhooks subcategory: projects_v2_item supported-webhook-types: - organization projects-v2-item-deleted: post: summary: 'This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-server@3.9/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#projectv2item). For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).' description: An item was deleted from a project in the organization. operationId: projects-v2-item/deleted externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: project-v2-item schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-projects-v2-item-deleted' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false enabledForGitHubApps: true category: webhooks subcategory: projects_v2_item supported-webhook-types: - organization projects-v2-item-edited: post: summary: 'This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-server@3.9/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#projectv2item). For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).' description: The values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue. operationId: projects-v2-item/edited externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: project-v2-item schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-projects-v2-item-edited' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false enabledForGitHubApps: true category: webhooks subcategory: projects_v2_item supported-webhook-types: - organization projects-v2-item-reordered: post: summary: 'This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-server@3.9/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#projectv2item). For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).' description: The position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout. operationId: projects-v2-item/reordered externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: project-v2-item schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-projects-v2-item-reordered' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false enabledForGitHubApps: true category: webhooks subcategory: projects_v2_item supported-webhook-types: - organization projects-v2-item-restored: post: summary: 'This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-server@3.9/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#projectv2item). For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).' description: An archived item on an organization project was restored from the archive. For more information, see "[Archiving items from your project](https://docs.github.com/enterprise-server@3.9/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project)." operationId: projects-v2-item/restored externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: project-v2-item schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-projects-v2-item-restored' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false enabledForGitHubApps: true category: webhooks subcategory: projects_v2_item supported-webhook-types: - organization projects-v2-reopened: post: summary: 'This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-server@3.9/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#projectv2). For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. **Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).' description: A project in the organization was reopened. operationId: projects-v2/reopened externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#projects_v2 parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: project-v2 schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-projects-v2-project-reopened' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false enabledForGitHubApps: true category: webhooks subcategory: projects_v2 supported-webhook-types: - organization public: post: summary: 'This event occurs when repository visibility changes from private to public. For more information, see "[Setting repository visibility](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility)." To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.' operationId: public externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#public parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-public' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: public supported-webhook-types: - repository - organization - app pull-request-assigned: post: summary: 'This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.' description: A pull request was assigned to a user. operationId: pull-request/assigned externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-pull-request-assigned' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request supported-webhook-types: - repository - organization - app pull-request-auto-merge-disabled: post: summary: 'This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.' description: Auto merge was disabled for a pull request. For more information, see "[Automatically merging a pull request](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)." operationId: pull-request/auto-merge-disabled externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-pull-request-auto-merge-disabled' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request supported-webhook-types: - repository - organization - app pull-request-auto-merge-enabled: post: summary: 'This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.' description: Auto merge was enabled for a pull request. For more information, see "[Automatically merging a pull request](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)." operationId: pull-request/auto-merge-enabled externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-pull-request-auto-merge-enabled' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request supported-webhook-types: - repository - organization - app pull-request-closed: post: summary: 'This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.' description: A pull request was closed. If `merged` is false in the webhook payload, the pull request was closed with unmerged commits. If `merged` is true in the webhook payload, the pull request was merged. operationId: pull-request/closed externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-pull-request-closed' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request supported-webhook-types: - repository - organization - app pull-request-converted-to-draft: post: summary: 'This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.' description: A pull request was converted to a draft. For more information, see "[Changing the stage of a pull request](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)." operationId: pull-request/converted-to-draft externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-pull-request-converted-to-draft' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request supported-webhook-types: - repository - organization - app pull-request-demilestoned: post: summary: 'This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.' description: A pull request was removed from a milestone. operationId: pull-request/demilestoned externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-pull-request-demilestoned' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request supported-webhook-types: - repository - organization - app pull-request-edited: post: summary: 'This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.' description: The title or body of a pull request was edited, or the base branch of a pull request was changed. operationId: pull-request/edited externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-pull-request-edited' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request supported-webhook-types: - repository - organization - app pull-request-labeled: post: summary: 'This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.' description: A label was added to a pull request. operationId: pull-request/labeled externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-pull-request-labeled' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request supported-webhook-types: - repository - organization - app pull-request-locked: post: summary: 'This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.' description: Conversation on a pull request was locked. For more information, see "[Locking conversations](https://docs.github.com/enterprise-server@3.9/communities/moderating-comments-and-conversations/locking-conversations)." operationId: pull-request/locked externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-pull-request-locked' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request supported-webhook-types: - repository - organization - app pull-request-milestoned: post: summary: 'This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.' description: A pull request was added to a milestone. operationId: pull-request/milestoned externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-pull-request-milestoned' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request supported-webhook-types: - repository - organization - app pull-request-opened: post: summary: 'This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.' description: A pull request was created operationId: pull-request/opened externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-pull-request-opened' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request supported-webhook-types: - repository - organization - app pull-request-ready-for-review: post: summary: 'This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.' description: A draft pull request was marked as ready for review. For more information, see "[Changing the stage of a pull request](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)." operationId: pull-request/ready-for-review externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-pull-request-ready-for-review' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request supported-webhook-types: - repository - organization - app pull-request-reopened: post: summary: 'This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.' description: A previously closed pull request was reopened. operationId: pull-request/reopened externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-pull-request-reopened' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request supported-webhook-types: - repository - organization - app pull-request-review-comment-created: post: summary: 'This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request''s diff. For more information, see "[Commenting on a pull request](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/enterprise-server@3.9/rest/pulls/comments)" in the REST API documentation. For activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.' description: A comment on a pull request diff was created. operationId: pull-request-review-comment/created externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request_review_comment parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-pull-request-review-comment-created' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request_review_comment supported-webhook-types: - repository - organization - app pull-request-review-comment-deleted: post: summary: 'This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request''s diff. For more information, see "[Commenting on a pull request](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/enterprise-server@3.9/rest/pulls/comments)" in the REST API documentation. For activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.' description: A comment on a pull request diff was deleted. operationId: pull-request-review-comment/deleted externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request_review_comment parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-pull-request-review-comment-deleted' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request_review_comment supported-webhook-types: - repository - organization - app pull-request-review-comment-edited: post: summary: 'This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request''s diff. For more information, see "[Commenting on a pull request](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/enterprise-server@3.9/rest/pulls/comments)" in the REST API documentation. For activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.' description: The content of a comment on a pull request diff was changed. operationId: pull-request-review-comment/edited externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request_review_comment parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-pull-request-review-comment-edited' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request_review_comment supported-webhook-types: - repository - organization - app pull-request-review-dismissed: post: summary: 'This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/enterprise-server@3.9/rest/pulls/reviews)" in the REST API documentation. For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.' description: A review on a pull request was dismissed. operationId: pull-request-review/dismissed externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request_review parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-pull-request-review-dismissed' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request_review supported-webhook-types: - repository - organization - app pull-request-review-edited: post: summary: 'This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/enterprise-server@3.9/rest/pulls/reviews)" in the REST API documentation. For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.' description: The body comment on a pull request review was edited. operationId: pull-request-review/edited externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request_review parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-pull-request-review-edited' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request_review supported-webhook-types: - repository - organization - app pull-request-review-request-removed: post: summary: 'This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.' description: A request for review by a person or team was removed from a pull request. operationId: pull-request/review-request-removed externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-pull-request-review-request-removed' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request supported-webhook-types: - repository - organization - app pull-request-review-requested: post: summary: 'This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.' description: Review by a person or team was requested for a pull request. For more information, see "[Requesting a pull request review](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review)." operationId: pull-request/review-requested externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-pull-request-review-requested' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request supported-webhook-types: - repository - organization - app pull-request-review-submitted: post: summary: 'This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/enterprise-server@3.9/rest/pulls/reviews)" in the REST API documentation. For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.' description: A review on a pull request was submitted. operationId: pull-request-review/submitted externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request_review parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-pull-request-review-submitted' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request_review supported-webhook-types: - repository - organization - app pull-request-review-thread-resolved: post: summary: 'This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/enterprise-server@3.9/rest/pulls/comments)" in the REST API documentation. For activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.' description: A comment thread on a pull request was marked as resolved. operationId: pull-request-review-thread/resolved externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request_review_thread parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-pull-request-review-thread-resolved' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request_review_thread supported-webhook-types: - repository - organization - app pull-request-review-thread-unresolved: post: summary: 'This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/enterprise-server@3.9/rest/pulls/comments)" in the REST API documentation. For activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.' description: A previously resolved comment thread on a pull request was marked as unresolved. operationId: pull-request-review-thread/unresolved externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request_review_thread parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-pull-request-review-thread-unresolved' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request_review_thread supported-webhook-types: - repository - organization - app pull-request-synchronize: post: summary: 'This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.' description: A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch. operationId: pull-request/synchronize externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-pull-request-synchronize' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request supported-webhook-types: - repository - organization - app pull-request-unassigned: post: summary: 'This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.' description: A user was unassigned from a pull request. operationId: pull-request/unassigned externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-pull-request-unassigned' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request supported-webhook-types: - repository - organization - app pull-request-unlabeled: post: summary: 'This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.' description: A label was removed from a pull request. operationId: pull-request/unlabeled externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-pull-request-unlabeled' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request supported-webhook-types: - repository - organization - app pull-request-unlocked: post: summary: 'This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.' description: Conversation on a pull request was unlocked. For more information, see "[Locking conversations](https://docs.github.com/enterprise-server@3.9/communities/moderating-comments-and-conversations/locking-conversations)." operationId: pull-request/unlocked externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-pull-request-unlocked' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request supported-webhook-types: - repository - organization - app push: post: summary: 'This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed, when a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch and tag deletions, use the [`delete`](#delete) webhook event. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. **Note**: An event will not be created when more than three tags are pushed at once.' operationId: push externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#push parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-push' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: push supported-webhook-types: - repository - organization - app registry-package-published: post: summary: 'This event occurs when there is activity relating to GitHub Packages. For more information, see "[Introduction to GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#package) or "[Packages](https://docs.github.com/enterprise-server@3.9/rest/packages)" in the REST API documentation. To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission. **Note**: GitHub recommends that you use the newer `package` event instead.' description: A package was published to a registry. operationId: registry-package/published externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#registry_package parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-registry-package-published' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: registry_package supported-webhook-types: - repository - organization - app registry-package-updated: post: summary: 'This event occurs when there is activity relating to GitHub Packages. For more information, see "[Introduction to GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#package) or "[Packages](https://docs.github.com/enterprise-server@3.9/rest/packages)" in the REST API documentation. To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission. **Note**: GitHub recommends that you use the newer `package` event instead.' description: A package that was previously published to a registry was updated. operationId: registry-package/updated externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#registry_package parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-registry-package-updated' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: registry_package supported-webhook-types: - repository - organization - app release-created: post: summary: 'This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-server@3.9/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-server@3.9/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.' description: A draft was saved, or a release or pre-release was published without previously being saved as a draft. operationId: release/created externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#release parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-release-created' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: release supported-webhook-types: - repository - organization - app release-deleted: post: summary: 'This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-server@3.9/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-server@3.9/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.' description: A release, pre-release, or draft release was deleted. operationId: release/deleted externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#release parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-release-deleted' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: release supported-webhook-types: - repository - organization - app release-edited: post: summary: 'This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-server@3.9/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-server@3.9/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.' description: The details of a release, pre-release, or draft release were edited. For more information, see "[Managing releases in a repository](https://docs.github.com/enterprise-server@3.9/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release)." operationId: release/edited externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#release parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-release-edited' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: release supported-webhook-types: - repository - organization - app release-prereleased: post: summary: 'This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-server@3.9/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-server@3.9/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.' description: A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable. operationId: release/prereleased externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#release parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-release-prereleased' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: release supported-webhook-types: - repository - organization - app release-published: post: summary: 'This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-server@3.9/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-server@3.9/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.' description: A release, pre-release, or draft of a release was published. operationId: release/published externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#release parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-release-published' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: release supported-webhook-types: - repository - organization - app release-released: post: summary: 'This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-server@3.9/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-server@3.9/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.' description: A release was published, or a pre-release was changed to a release. operationId: release/released externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#release parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-release-released' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: release supported-webhook-types: - repository - organization - app release-unpublished: post: summary: 'This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-server@3.9/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-server@3.9/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.' description: A release or pre-release was unpublished. operationId: release/unpublished externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#release parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-release-unpublished' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: release supported-webhook-types: - repository - organization - app repository-anonymous-access-disabled: post: summary: 'This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-server@3.9/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.9/rest/repos)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.' description: Someone disabled anonymous Git read access to the repository. For more information, see "[Enabling anonymous Git read access for a repository](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/enabling-anonymous-git-read-access-for-a-repository)." operationId: repository/anonymous-access-disabled externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-repository-anonymous-access-disabled' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: repository supported-webhook-types: - app - business - organization - repository repository-anonymous-access-enabled: post: summary: 'This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-server@3.9/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.9/rest/repos)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.' description: Someone enabled anonymous Git read access to the repository. For more information, see "[Enabling anonymous Git read access for a repository](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/enabling-anonymous-git-read-access-for-a-repository)." operationId: repository/anonymous-access-enabled externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-repository-anonymous-access-enabled' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: repository supported-webhook-types: - app - business - organization - repository repository-archived: post: summary: 'This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-server@3.9/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.9/rest/repos)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.' description: A repository was archived. operationId: repository/archived externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-repository-archived' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: repository supported-webhook-types: - business - repository - organization - app repository-created: post: summary: 'This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-server@3.9/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.9/rest/repos)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.' description: A repository was created. operationId: repository/created externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-repository-created' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: repository supported-webhook-types: - business - repository - organization - app repository-deleted: post: summary: 'This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-server@3.9/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.9/rest/repos)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.' description: A repository was deleted. GitHub Apps and repository webhooks will not receive this event. operationId: repository/deleted externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-repository-deleted' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: repository supported-webhook-types: - business - repository - organization - app repository-dispatch-sample.collected: post: summary: 'This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#create-a-repository-dispatch-event). To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.' description: The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. operationId: repository-dispatch/sample.collected externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#repository_dispatch parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-repository-dispatch-sample' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: repository_dispatch supported-webhook-types: - app repository-edited: post: summary: 'This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-server@3.9/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.9/rest/repos)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.' description: The topics, default branch, description, or homepage of a repository was changed. operationId: repository/edited externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-repository-edited' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: repository supported-webhook-types: - business - repository - organization - app repository-privatized: post: summary: 'This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-server@3.9/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.9/rest/repos)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.' description: The visibility of a repository was changed to `private`. operationId: repository/privatized externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-repository-privatized' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: repository supported-webhook-types: - business - repository - organization - app repository-publicized: post: summary: 'This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-server@3.9/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.9/rest/repos)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.' description: The visibility of a repository was changed to `public`. operationId: repository/publicized externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-repository-publicized' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: repository supported-webhook-types: - business - repository - organization - app repository-renamed: post: summary: 'This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-server@3.9/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.9/rest/repos)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.' description: The name of a repository was changed. operationId: repository/renamed externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-repository-renamed' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: repository supported-webhook-types: - business - repository - organization - app repository-transferred: post: summary: 'This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-server@3.9/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.9/rest/repos)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.' description: Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the `repository.transferred` event, the new owner account must have the GitHub App installed, and the App must be subscribed to "Repository" events. operationId: repository/transferred externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-repository-transferred' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: repository supported-webhook-types: - business - repository - organization - app repository-unarchived: post: summary: 'This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-server@3.9/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.9/rest/repos)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.' description: A previously archived repository was unarchived. operationId: repository/unarchived externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-repository-unarchived' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: repository supported-webhook-types: - business - repository - organization - app repository-vulnerability-alert-create: post: summary: 'This event occurs when there is activity relating to a security vulnerability alert in a repository. **Note**: This event is deprecated. Use the `dependabot_alert` event instead.' description: A repository vulnerability alert was created. operationId: repository-vulnerability-alert/create externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#repository_vulnerability_alert parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-repository-vulnerability-alert-create' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: repository_vulnerability_alert supported-webhook-types: - repository - organization repository-vulnerability-alert-dismiss: post: summary: 'This event occurs when there is activity relating to a security vulnerability alert in a repository. **Note**: This event is deprecated. Use the `dependabot_alert` event instead.' description: A repository vulnerability alert was dismissed. operationId: repository-vulnerability-alert/dismiss externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#repository_vulnerability_alert parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-repository-vulnerability-alert-dismiss' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: repository_vulnerability_alert supported-webhook-types: - repository - organization repository-vulnerability-alert-reopen: post: summary: 'This event occurs when there is activity relating to a security vulnerability alert in a repository. **Note**: This event is deprecated. Use the `dependabot_alert` event instead.' description: A previously dismissed or resolved repository vulnerability alert was reopened. operationId: repository-vulnerability-alert/reopen externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#repository_vulnerability_alert parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-repository-vulnerability-alert-reopen' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: repository_vulnerability_alert supported-webhook-types: - repository - organization repository-vulnerability-alert-resolve: post: summary: 'This event occurs when there is activity relating to a security vulnerability alert in a repository. **Note**: This event is deprecated. Use the `dependabot_alert` event instead.' description: A repository vulnerability alert was marked as resolved. operationId: repository-vulnerability-alert/resolve externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#repository_vulnerability_alert parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-repository-vulnerability-alert-resolve' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: repository_vulnerability_alert supported-webhook-types: - repository - organization secret-scanning-alert-created: post: summary: 'This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-server@3.9/rest/secret-scanning)" in the REST API documentation. For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission.' description: A secret scanning alert was created. operationId: secret-scanning-alert/created externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-secret-scanning-alert-created' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: secret_scanning_alert supported-webhook-types: - repository - organization - app secret-scanning-alert-location-created: post: summary: 'This event occurs when there is activity relating to the locations of a secret in a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-server@3.9/rest/secret-scanning)" in the REST API documentation. For activity relating to secret scanning alerts, use the `secret_scanning_alert` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission.' description: A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert. operationId: secret-scanning-alert-location/created externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#secret_scanning_alert_location parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-secret-scanning-alert-location-created' examples: default: $ref: '#/components/examples/secret-scanning-alert-location-created' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/webhook-secret-scanning-alert-location-created-form-encoded' examples: default: $ref: '#/components/examples/secret-scanning-alert-location-created-form-encoded' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false enabledForGitHubApps: true category: webhooks subcategory: secret_scanning_alert_location supported-webhook-types: - repository - organization - app secret-scanning-alert-reopened: post: summary: 'This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-server@3.9/rest/secret-scanning)" in the REST API documentation. For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission.' description: A previously closed secret scanning alert was reopened. operationId: secret-scanning-alert/reopened externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-secret-scanning-alert-reopened' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: secret_scanning_alert supported-webhook-types: - repository - organization - app secret-scanning-alert-resolved: post: summary: 'This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-server@3.9/rest/secret-scanning)" in the REST API documentation. For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission.' description: A secret scanning alert was closed. operationId: secret-scanning-alert/resolved externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-secret-scanning-alert-resolved' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: secret_scanning_alert supported-webhook-types: - repository - organization - app secret-scanning-alert-revoked: post: summary: 'This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-server@3.9/rest/secret-scanning)" in the REST API documentation. For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission.' description: A secret scanning alert was marked as revoked. operationId: secret-scanning-alert/revoked externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-secret-scanning-alert-revoked' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: secret_scanning_alert supported-webhook-types: - repository - organization - app security-advisory-published: post: summary: 'This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/enterprise-server@3.9/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-server@3.9/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#securityadvisory). GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/enterprise-server@3.9/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)."' description: A security advisory was published to the GitHub community. operationId: security-advisory/published externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#security_advisory parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-security-advisory-published' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: security_advisory supported-webhook-types: - app security-advisory-updated: post: summary: 'This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/enterprise-server@3.9/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-server@3.9/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#securityadvisory). GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/enterprise-server@3.9/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)."' description: The metadata or description of a security advisory was changed. operationId: security-advisory/updated externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#security_advisory parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-security-advisory-updated' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: security_advisory supported-webhook-types: - app security-advisory-withdrawn: post: summary: 'This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/enterprise-server@3.9/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-server@3.9/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#securityadvisory). GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/enterprise-server@3.9/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)."' description: A previously published security advisory was withdrawn. operationId: security-advisory/withdrawn externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#security_advisory parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-security-advisory-withdrawn' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: security_advisory supported-webhook-types: - app security-and-analysis: post: summary: 'This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see "[GitHub security features](https://docs.github.com/enterprise-server@3.9/code-security/getting-started/github-security-features)." To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission.' operationId: security-and-analysis externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#security_and_analysis parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-security-and-analysis' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: security_and_analysis supported-webhook-types: - repository - organization - app sponsorship-cancelled: post: summary: 'This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/enterprise-server@3.9/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#sponsorship). You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-server@3.9/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)."' description: 'A sponsorship was cancelled and the last billing cycle has ended. This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.' operationId: sponsorship/cancelled externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-sponsorship-cancelled' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: sponsorship supported-webhook-types: - sponsors_listing sponsorship-created: post: summary: 'This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/enterprise-server@3.9/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#sponsorship). You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-server@3.9/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)."' description: A sponsor created a sponsorship for a sponsored account. This event occurs once the payment is successfully processed. operationId: sponsorship/created externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-sponsorship-created' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: sponsorship supported-webhook-types: - sponsors_listing sponsorship-edited: post: summary: 'This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/enterprise-server@3.9/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#sponsorship). You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-server@3.9/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)."' description: A monthly sponsor changed who can see their sponsorship. If you recognize your sponsors publicly, you may want to update your sponsor recognition to reflect the change when this event occurs. operationId: sponsorship/edited externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-sponsorship-edited' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: sponsorship supported-webhook-types: - sponsors_listing sponsorship-pending-cancellation: post: summary: 'This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/enterprise-server@3.9/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#sponsorship). You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-server@3.9/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)."' description: 'A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date. This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.' operationId: sponsorship/pending-cancellation externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-sponsorship-pending-cancellation' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: sponsorship supported-webhook-types: - sponsors_listing sponsorship-pending-tier-change: post: summary: 'This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/enterprise-server@3.9/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#sponsorship). You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-server@3.9/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)."' description: A sponsor scheduled a downgrade to a lower sponsorship tier. The new tier will become effective on their next billing date. operationId: sponsorship/pending-tier-change externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-sponsorship-pending-tier-change' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: sponsorship supported-webhook-types: - sponsors_listing sponsorship-tier-changed: post: summary: 'This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/enterprise-server@3.9/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#sponsorship). You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-server@3.9/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)."' description: A sponsor changed the tier of their sponsorship and the change has taken effect. If a sponsor upgraded their tier, the change took effect immediately. If a sponsor downgraded their tier, the change took effect at the beginning of the sponsor's next billing cycle. operationId: sponsorship/tier-changed externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-sponsorship-tier-changed' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: sponsorship supported-webhook-types: - sponsors_listing star-created: post: summary: 'This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/enterprise-server@3.9/get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/enterprise-server@3.9/rest/activity/starring)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.' description: Someone starred a repository. operationId: star/created externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#star parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-star-created' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: star supported-webhook-types: - repository - organization - app star-deleted: post: summary: 'This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/enterprise-server@3.9/get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/enterprise-server@3.9/rest/activity/starring)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.' description: Someone unstarred the repository. operationId: star/deleted externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#star parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-star-deleted' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: star supported-webhook-types: - repository - organization - app status: post: summary: 'This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see "[About status checks](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)." For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#status) or "[Commit statuses](https://docs.github.com/enterprise-server@3.9/rest/commits/statuses)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Commit statuses" repository permission.' operationId: status externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#status parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-status' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: status supported-webhook-types: - repository - organization - app team-add: post: summary: 'This event occurs when a team is added to a repository. For more information, see "[Managing teams and people with access to your repository](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository)." For activity relating to teams, see the `teams` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.' operationId: team-add externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#team_add parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-team-add' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: team_add supported-webhook-types: - repository - organization - app team-added-to-repository: post: summary: 'This event occurs when there is activity relating to teams in an organization. For more information, see "[About teams](https://docs.github.com/enterprise-server@3.9/organizations/organizing-members-into-teams/about-teams)." To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.' description: A team was granted access to a repository. operationId: team/added-to-repository externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#team parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-team-added-to-repository' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: team supported-webhook-types: - organization - business - app team-created: post: summary: 'This event occurs when there is activity relating to teams in an organization. For more information, see "[About teams](https://docs.github.com/enterprise-server@3.9/organizations/organizing-members-into-teams/about-teams)." To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.' description: A team was created. operationId: team/created externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#team parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-team-created' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: team supported-webhook-types: - organization - business - app team-deleted: post: summary: 'This event occurs when there is activity relating to teams in an organization. For more information, see "[About teams](https://docs.github.com/enterprise-server@3.9/organizations/organizing-members-into-teams/about-teams)." To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.' description: A team was deleted. operationId: team/deleted externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#team parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-team-deleted' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: team supported-webhook-types: - organization - business - app team-edited: post: summary: 'This event occurs when there is activity relating to teams in an organization. For more information, see "[About teams](https://docs.github.com/enterprise-server@3.9/organizations/organizing-members-into-teams/about-teams)." To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.' description: The name, description, or visibility of a team was changed. operationId: team/edited externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#team parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-team-edited' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: team supported-webhook-types: - organization - business - app team-removed-from-repository: post: summary: 'This event occurs when there is activity relating to teams in an organization. For more information, see "[About teams](https://docs.github.com/enterprise-server@3.9/organizations/organizing-members-into-teams/about-teams)." To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.' description: A team's access to a repository was removed. operationId: team/removed-from-repository externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#team parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-team-removed-from-repository' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: team supported-webhook-types: - organization - business - app user-created: post: summary: This event occurs when there is activity relating to user accounts in an enterprise. description: A user account was added to the enterprise. operationId: user/created externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#user parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-user-created' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: true category: webhooks subcategory: user supported-webhook-types: - business user-deleted: post: summary: This event occurs when there is activity relating to user accounts in an enterprise. description: A user account was removed from the enterprise. operationId: user/deleted externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#user parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-user-deleted' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: true category: webhooks subcategory: user supported-webhook-types: - business watch-started: post: summary: 'This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see "[Managing your subscriptions](https://docs.github.com/enterprise-server@3.9/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions)." For information about the APIs to manage watching, see "[Watching](https://docs.github.com/enterprise-server@3.9/rest/activity/watching)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.' description: Someone started watching the repository. operationId: watch/started externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#watch parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-watch-started' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: watch supported-webhook-types: - repository - organization - app workflow-dispatch: post: summary: 'This event occurs when a GitHub Actions workflow is manually triggered. For more information, see "[Manually running a workflow](https://docs.github.com/enterprise-server@3.9/actions/managing-workflow-runs/manually-running-a-workflow)." For activity relating to workflow runs, use the `workflow_run` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.' operationId: workflow-dispatch externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#workflow_dispatch parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-workflow-dispatch' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: workflow_dispatch supported-webhook-types: - app workflow-job-completed: post: summary: 'This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/enterprise-server@3.9/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-jobs)" in the REST API documentation. For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission.' description: A job in a workflow run finished. This event occurs when a job in a workflow is completed, regardless of whether the job was successful or unsuccessful. operationId: workflow-job/completed externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#workflow_job parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-workflow-job-completed' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: workflow_job supported-webhook-types: - business - repository - organization - app workflow-job-in-progress: post: summary: 'This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/enterprise-server@3.9/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-jobs)" in the REST API documentation. For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission.' description: A job in a workflow run started processing on a runner. operationId: workflow-job/in-progress externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#workflow_job parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-workflow-job-in-progress' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: workflow_job supported-webhook-types: - business - repository - organization - app workflow-job-queued: post: summary: 'This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/enterprise-server@3.9/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-jobs)" in the REST API documentation. For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission.' description: A job in a workflow run was created. operationId: workflow-job/queued externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#workflow_job parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-workflow-job-queued' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: workflow_job supported-webhook-types: - business - repository - organization - app workflow-job-waiting: post: summary: 'This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/enterprise-server@3.9/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-jobs)" in the REST API documentation. For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission.' description: A job in a workflow run was created and is waiting for approvals. operationId: workflow-job/waiting externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#workflow_job parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-workflow-job-waiting' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: workflow_job supported-webhook-types: - business - repository - organization - app workflow-run-completed: post: summary: 'This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see "[About workflows](https://docs.github.com/enterprise-server@3.9/actions/using-workflows/about-workflows)." For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#workflowrun) or "[Workflow runs](https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs)" in the REST API documentation. For activity relating to a job in a workflow run, use the `workflow_job` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission.' description: A workflow run finished. This event occurs when a workflow run is completed, regardless of whether the workflow was successful or unsuccessful. operationId: workflow-run/completed externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#workflow_run parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-workflow-run-completed' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: workflow_run supported-webhook-types: - business - repository - organization - app workflow-run-in-progress: post: summary: 'This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see "[About workflows](https://docs.github.com/enterprise-server@3.9/actions/using-workflows/about-workflows)." For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#workflowrun) or "[Workflow runs](https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs)" in the REST API documentation. For activity relating to a job in a workflow run, use the `workflow_job` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission.' description: A workflow run started processing on a runner. operationId: workflow-run/in-progress externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#workflow_run parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-workflow-run-in-progress' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: workflow_run supported-webhook-types: - business - repository - organization - app workflow-run-requested: post: summary: 'This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see "[About workflows](https://docs.github.com/enterprise-server@3.9/actions/using-workflows/about-workflows)." For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#workflowrun) or "[Workflow runs](https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs)" in the REST API documentation. For activity relating to a job in a workflow run, use the `workflow_job` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission.' description: A workflow run was triggered. operationId: workflow-run/requested externalDocs: url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#workflow_run parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string - name: X-GitHub-Enterprise-Version in: header example: 3.1.9 schema: type: string - name: X-GitHub-Enterprise-Host in: header example: ghes.github.com schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/webhook-workflow-run-requested' responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: workflow_run supported-webhook-types: - business - repository - organization - app