openapi: 3.0.3 info: version: 1.1.4 title: GitHub Application About Runs 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: Runs paths: /repos/{owner}/{repo}/actions/runs/{run_id}/approvals: get: summary: GitHub Get the Review History Forworkflow Run description: 'Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.' tags: - Runs operationId: getTheReviewHistoryForworkflowRun externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/run-id' responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/environment-approvals' examples: default: $ref: '#/components/examples/environment-approvals-items' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-runs security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/jobs/{job_id}: get: summary: GitHub Get Job for Workflow Run description: 'Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.' tags: - Runs operationId: getJobForWorkflowRun externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/job-id' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/job' examples: default: $ref: '#/components/examples/job' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-jobs security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/jobs/{job_id}/logs: get: summary: GitHub Download Job Logs for Workflow Run description: 'Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.' tags: - Runs operationId: downloadJobLogsForWorkflowRun externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/job-id' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '302': description: Response headers: Location: example: https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/jobs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D schema: type: string x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-jobs security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/jobs/{job_id}/rerun: post: summary: GitHub Re-run Job from Workflow Run description: 'Re-run a job and its dependent jobs in a workflow run. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.' tags: - Runs operationId: rerunJobFromWorkflowRun externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/job-id' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value requestBody: required: false content: application/json: schema: type: object properties: enable_debug_logging: type: boolean default: false description: Whether to enable debug logging for the re-run. examples: default: value: {} responses: '201': description: Response content: application/json: schema: $ref: '#/components/schemas/empty-object' examples: default: value: {} '403': $ref: '#/components/responses/forbidden' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-runs security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/runs: get: summary: GitHub List Workflow Runs for Repository description: 'Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#parameters). Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.' tags: - Runs operationId: listWorkflowRunsForRepository externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/actor' - $ref: '#/components/parameters/workflow-run-branch' - $ref: '#/components/parameters/event' - $ref: '#/components/parameters/workflow-run-status' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/created' - $ref: '#/components/parameters/exclude-pull-requests' - $ref: '#/components/parameters/workflow-run-check-suite-id' - $ref: '#/components/parameters/workflow-run-head-sha' - 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: object required: - total_count - workflow_runs properties: total_count: type: integer workflow_runs: type: array items: $ref: '#/components/schemas/workflow-run' examples: default: $ref: '#/components/examples/workflow-run-paginated' headers: Link: $ref: '#/components/headers/link' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-runs 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}/actions/runs/{run_id}: get: summary: GitHub Get Workflow Run description: 'Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.' tags: - Runs operationId: getWorkflowRun externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#get-a-workflow-run parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/run-id' - $ref: '#/components/parameters/exclude-pull-requests' - 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/workflow-run' examples: default: $ref: '#/components/examples/workflow-run' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-runs security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: GitHub Delete Workflow Run description: 'Deletes a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.' operationId: deleteWorkflowRun tags: - Runs externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#delete-a-workflow-run parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/run-id' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-runs security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts: get: summary: GitHub List Workflow Run Artifacts description: 'Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.' tags: - Runs operationId: listWorkflowRunArtifacts externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/artifacts#list-workflow-run-artifacts parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/run-id' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/artifact-name' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: type: object required: - total_count - artifacts properties: total_count: type: integer artifacts: type: array items: $ref: '#/components/schemas/artifact' examples: default: $ref: '#/components/examples/artifact-paginated' headers: Link: $ref: '#/components/headers/link' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: artifacts security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}: get: summary: GitHub Get Workflow Run Attempt description: 'Gets a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.' tags: - Runs operationId: getWorkflowRunAttempt externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/run-id' - $ref: '#/components/parameters/attempt-number' - $ref: '#/components/parameters/exclude-pull-requests' - 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/workflow-run' examples: default: $ref: '#/components/examples/workflow-run' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-runs security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs: get: summary: GitHub List Jobs for Workflow Run Attempt description: 'Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#parameters). Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.' tags: - Runs operationId: listJobsForWorkflowRunAttempt externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/run-id' - $ref: '#/components/parameters/attempt-number' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: type: object required: - total_count - jobs properties: total_count: type: integer jobs: type: array items: $ref: '#/components/schemas/job' examples: default: $ref: '#/components/examples/job-paginated' headers: Link: $ref: '#/components/headers/link' '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-jobs security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs: get: summary: GitHub Download Workflow Run Attempt Logs description: 'Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after 1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.' tags: - Runs operationId: downloadWorkflowRunAttemptLogs externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/run-id' - $ref: '#/components/parameters/attempt-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: '302': description: Response headers: Location: example: https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D schema: type: string x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-runs security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/runs/{run_id}/cancel: post: summary: GitHub Cancel Workflow Run description: 'Cancels workflow run using its `id`. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.' tags: - Runs operationId: cancelWorkflowRun externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#cancel-a-workflow-run parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/run-id' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '202': description: Response content: application/json: schema: $ref: '#/components/schemas/empty-object' examples: default: value: {} '409': $ref: '#/components/responses/conflict' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-runs security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/runs/{run_id}/jobs: get: summary: GitHub List Jobs for Workflow Run description: 'Lists jobs for workflow run. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#parameters). Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private repository.' tags: - Runs operationId: listJobsForWorkflowRun externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/run-id' - name: filter description: Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all jobs for workflow run, including from old executions of the workflow run. in: query required: false schema: type: string enum: - latest - all default: latest example: latest - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: type: object required: - total_count - jobs properties: total_count: type: integer jobs: type: array items: $ref: '#/components/schemas/job' examples: default: $ref: '#/components/examples/job-paginated' headers: Link: $ref: '#/components/headers/link' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-jobs security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/runs/{run_id}/logs: get: summary: GitHub Download Workflow Run Logs description: 'Gets redirect URL to download an archive of log files for workflow run. This link expires after 1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.' tags: - Runs operationId: downloadWorkflowRunLogs externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#download-workflow-run-logs parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/run-id' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '302': description: Response headers: Location: example: https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D schema: type: string x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-runs security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: GitHub Delete Workflow Run Logs description: 'Deletes all logs for a workflow run. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.' tags: - Runs operationId: deleteWorkflowRunLogs externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#delete-workflow-run-logs parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/run-id' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '204': description: Response '403': $ref: '#/components/responses/forbidden' '500': $ref: '#/components/responses/internal_error' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-runs security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments: get: summary: GitHub Get Pending Deployments for Workflow Run description: 'Get all deployment environments for a workflow run that are waiting for protection rules to pass. Anyone with read access to the repository can use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.' tags: - Runs operationId: getPendingDeploymentsForWorkflowRun externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/run-id' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/pending-deployment' examples: default: $ref: '#/components/examples/pending-deployment-items' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-runs security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: GitHub Review Pending Deployments for Workflow Run description: 'Approve or reject pending deployments that are waiting on approval by a required reviewer. Required reviewers with read access to the repository contents and deployments can use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.' tags: - Runs operationId: reviewPendingDeploymentsForWorkflowRun externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/run-id' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value requestBody: required: true content: application/json: schema: type: object properties: environment_ids: type: array description: The list of environment ids to approve or reject example: - 161171787 - 161171795 items: type: integer example: 161171787 state: type: string description: Whether to approve or reject deployment to the specified environments. enum: - approved - rejected example: approved comment: type: string description: comment to accompany the deployment review example: Ship it! required: - environment_ids - state - comment examples: default: value: environment_ids: - 161171787 state: approved comment: Ship it! responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/deployment' examples: default: $ref: '#/components/examples/deployment-items' x-github: githubCloudOnly: false enabledForGitHubApps: false category: actions subcategory: workflow-runs security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs: post: summary: GitHub Re-run Failed Jobs from Workflow Run description: 'Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.' tags: - Runs operationId: rerunFailedJobsFromWorkflowRun externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/run-id' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value requestBody: required: false content: application/json: schema: type: object properties: enable_debug_logging: type: boolean default: false description: Whether to enable debug logging for the re-run. examples: default: value: {} responses: '201': description: Response content: application/json: schema: $ref: '#/components/schemas/empty-object' examples: default: value: {} x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-runs security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs: get: summary: GitHub List Workflow Runs for Workflow description: 'List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#parameters). Anyone with read access to the repository can use this endpoint OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.' tags: - Runs operationId: listWorkflowRunsForWorkflow externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/workflow-id' - $ref: '#/components/parameters/actor' - $ref: '#/components/parameters/workflow-run-branch' - $ref: '#/components/parameters/event' - $ref: '#/components/parameters/workflow-run-status' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/created' - $ref: '#/components/parameters/exclude-pull-requests' - $ref: '#/components/parameters/workflow-run-check-suite-id' - $ref: '#/components/parameters/workflow-run-head-sha' - 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: object required: - total_count - workflow_runs properties: total_count: type: integer workflow_runs: type: array items: $ref: '#/components/schemas/workflow-run' examples: default: $ref: '#/components/examples/workflow-run-paginated' headers: Link: $ref: '#/components/headers/link' x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-runs security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/check-runs: post: summary: GitHub Create Check Run description: Creates a new check run for a specific commit in a repository. To create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite. array. tags: - Runs operationId: createCheckRun externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/checks/runs#create-a-check-run 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 requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: The name of the check. For example, "code-coverage". head_sha: type: string description: The SHA of the commit. details_url: type: string description: The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used. external_id: type: string description: reference for the run on the integrator's system. status: type: string description: The current status. enum: - queued - in_progress - completed default: queued started_at: type: string format: date-time description: 'The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' conclusion: type: string description: '**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.' enum: - action_required - cancelled - failure - neutral - success - skipped - stale - timed_out completed_at: type: string format: date-time description: 'The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' output: type: object description: Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. properties: title: type: string description: The title of the check run. summary: type: string maxLength: 65535 description: 'The summary of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters.' text: type: string maxLength: 65535 description: 'The details of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters.' annotations: type: array description: Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.9/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about how you can view annotations on GitHub, see "[About status checks](https://docs.github.com/enterprise-server@3.9/articles/about-status-checks#checks)". maxItems: 50 items: type: object properties: path: type: string description: The path of the file to add an annotation to. For example, `assets/css/main.css`. start_line: type: integer description: The start line of the annotation. Line numbers start at 1. end_line: type: integer description: The end line of the annotation. start_column: type: integer description: The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. Column numbers start at 1. end_column: type: integer description: The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. annotation_level: type: string description: The level of the annotation. enum: - notice - warning - failure message: type: string description: short description of the feedback for these lines of code. The maximum size is 64 KB. title: type: string description: The title that represents the annotation. The maximum size is 255 characters. raw_details: type: string description: Details about this annotation. The maximum size is 64 KB. required: - path - start_line - end_line - annotation_level - message images: type: array description: Adds images to the output displayed in the GitHub pull request UI. items: type: object properties: alt: type: string description: The alternative text for the image. image_url: type: string description: The full URL of the image. caption: type: string description: short image description. required: - alt - image_url required: - title - summary actions: type: array description: Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/enterprise-server@3.9/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." maxItems: 3 items: type: object properties: label: type: string maxLength: 20 description: The text to be displayed on a button in the web UI. The maximum size is 20 characters. description: type: string maxLength: 40 description: short explanation of what this action would do. The maximum size is 40 characters. identifier: type: string maxLength: 20 description: reference for the action on the integrator's system. The maximum size is 20 characters. required: - label - description - identifier required: - name - head_sha oneOf: - properties: status: enum: - completed required: - status - conclusion additionalProperties: true - properties: status: enum: - queued - in_progress additionalProperties: true examples: example-of-in-progress-conclusion: summary: Example of an in_progress conclusion value: name: mighty_readme head_sha: ce587453ced02b1526dfb4cb910479d431683101 status: in_progress external_id: '42' started_at: '2018-05-04T01:14:52Z' output: title: Mighty Readme report summary: '' text: '' example-of-completed-conclusion: summary: Example of a completed conclusion value: name: mighty_readme head_sha: ce587453ced02b1526dfb4cb910479d431683101 status: completed started_at: '2017-11-30T19:39:10Z' conclusion: success completed_at: '2017-11-30T19:49:10Z' output: title: Mighty Readme report summary: There are 0 failures, 2 warnings, and 1 notices. text: You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app. annotations: - path: README.md annotation_level: warning title: Spell Checker message: Check your spelling for 'banaas'. raw_details: Do you mean 'bananas' or 'banana'? start_line: 2 end_line: 2 - path: README.md annotation_level: warning title: Spell Checker message: Check your spelling for 'aples' raw_details: Do you mean 'apples' or 'Naples' start_line: 4 end_line: 4 images: - alt: Super bananas image_url: http://example.com/images/42 actions: - label: Fix identifier: fix_errors description: Allow us to fix these errors for you responses: '201': description: Response content: application/json: schema: $ref: '#/components/schemas/check-run' examples: example-of-completed-conclusion: $ref: '#/components/examples/check-run-example-of-completed-conclusion' example-of-in-progress-conclusion: $ref: '#/components/examples/check-run-example-of-in-progress-conclusion' x-github: githubCloudOnly: false enabledForGitHubApps: true category: checks subcategory: runs security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/check-runs/{check_run_id}: get: summary: GitHub Get Check Run description: 'Gets a single check run using its `id`. **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.' tags: - Runs operationId: getCheckRun externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/checks/runs#get-a-check-run parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/check-run-id' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/check-run' examples: default: $ref: '#/components/examples/check-run' x-github: githubCloudOnly: false enabledForGitHubApps: true category: checks subcategory: runs security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: GitHub Update Check Run description: 'Updates a check run for a specific commit in a repository. **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. OAuth apps and personal access tokens (classic) cannot use this endpoint.' tags: - Runs operationId: updateCheckRun externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/checks/runs#update-a-check-run parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/check-run-id' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: The name of the check. For example, "code-coverage". details_url: type: string description: The URL of the integrator's site that has the full details of the check. external_id: type: string description: reference for the run on the integrator's system. started_at: type: string format: date-time description: 'This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' status: type: string description: The current status. enum: - queued - in_progress - completed conclusion: type: string description: '**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.' enum: - action_required - cancelled - failure - neutral - success - skipped - stale - timed_out completed_at: type: string format: date-time description: 'The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' output: type: object description: Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. properties: title: type: string description: '**Required**.' summary: type: string description: Can contain Markdown. maxLength: 65535 text: type: string description: Can contain Markdown. maxLength: 65535 annotations: type: array description: Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.9/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see "[About status checks](https://docs.github.com/enterprise-server@3.9/articles/about-status-checks#checks)". maxItems: 50 items: type: object properties: path: type: string description: The path of the file to add an annotation to. For example, `assets/css/main.css`. start_line: type: integer description: The start line of the annotation. Line numbers start at 1. end_line: type: integer description: The end line of the annotation. start_column: type: integer description: The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. Column numbers start at 1. end_column: type: integer description: The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. annotation_level: type: string description: The level of the annotation. enum: - notice - warning - failure message: type: string description: short description of the feedback for these lines of code. The maximum size is 64 KB. title: type: string description: The title that represents the annotation. The maximum size is 255 characters. raw_details: type: string description: Details about this annotation. The maximum size is 64 KB. required: - path - start_line - end_line - annotation_level - message images: type: array description: Adds images to the output displayed in the GitHub pull request UI. items: type: object properties: alt: type: string description: The alternative text for the image. image_url: type: string description: The full URL of the image. caption: type: string description: short image description. required: - alt - image_url required: - summary actions: type: array description: Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/enterprise-server@3.9/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." maxItems: 3 items: type: object properties: label: type: string maxLength: 20 description: The text to be displayed on a button in the web UI. The maximum size is 20 characters. description: type: string maxLength: 40 description: short explanation of what this action would do. The maximum size is 40 characters. identifier: type: string maxLength: 20 description: reference for the action on the integrator's system. The maximum size is 20 characters. required: - label - description - identifier anyOf: - properties: status: enum: - completed required: - conclusion additionalProperties: true - properties: status: enum: - queued - in_progress additionalProperties: true examples: default: value: name: mighty_readme started_at: '2018-05-04T01:14:52Z' status: completed conclusion: success completed_at: '2018-05-04T01:14:52Z' output: title: Mighty Readme report summary: There are 0 failures, 2 warnings, and 1 notices. text: You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app. annotations: - path: README.md annotation_level: warning title: Spell Checker message: Check your spelling for 'banaas'. raw_details: Do you mean 'bananas' or 'banana'? start_line: 2 end_line: 2 - path: README.md annotation_level: warning title: Spell Checker message: Check your spelling for 'aples' raw_details: Do you mean 'apples' or 'Naples' start_line: 4 end_line: 4 images: - alt: Super bananas image_url: http://example.com/images/42 responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/check-run' examples: default: $ref: '#/components/examples/check-run' x-github: githubCloudOnly: false enabledForGitHubApps: true category: checks subcategory: runs security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations: get: summary: GitHub List Check Run Annotations description: 'Lists annotations for a check run using the annotation `id`. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.' tags: - Runs operationId: listCheckRunAnnotations externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/checks/runs#list-check-run-annotations parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/check-run-id' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/check-annotation' examples: default: $ref: '#/components/examples/check-annotation-items' headers: Link: $ref: '#/components/headers/link' x-github: githubCloudOnly: false enabledForGitHubApps: true category: checks subcategory: runs security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest: post: summary: GitHub Rerequest Check Run description: 'Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". OAuth apps and personal access tokens (classic) cannot use this endpoint.' tags: - Runs operationId: rerequestCheckRun externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/checks/runs#rerequest-a-check-run parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/check-run-id' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '201': description: Response content: application/json: schema: $ref: '#/components/schemas/empty-object' examples: default: value: {} '403': description: Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App content: application/json: schema: $ref: '#/components/schemas/basic-error' '404': $ref: '#/components/responses/not_found' '422': description: Validation error if the check run is not rerequestable content: application/json: schema: $ref: '#/components/schemas/basic-error' x-github: githubCloudOnly: false enabledForGitHubApps: true category: checks subcategory: runs security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs: get: summary: GitHub List Check Runs in Check Suite description: 'Lists check runs for a check suite using its `id`. **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.' tags: - Runs operationId: listCheckRunsInCheckSuite externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/checks/runs#list-check-runs-in-a-check-suite parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/check-suite-id' - $ref: '#/components/parameters/check-name' - $ref: '#/components/parameters/status' - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. in: query required: false schema: type: string enum: - latest - all default: latest example: latest - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' - in: header name: Authorization schema: type: string example: example_value - in: header name: X-GitHub-Api-Version schema: type: string default: '2022-11-28' example: example_value - in: header name: Accept schema: type: string default: application/vnd.github+json example: example_value responses: '200': description: Response content: application/json: schema: type: object required: - total_count - check_runs properties: total_count: type: integer check_runs: type: array items: $ref: '#/components/schemas/check-run' examples: default: $ref: '#/components/examples/check-run-paginated' headers: Link: $ref: '#/components/headers/link' x-github: githubCloudOnly: false enabledForGitHubApps: true category: checks subcategory: runs security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/commits/{ref}/check-runs: get: summary: GitHub List Check Runs for Git Reference description: 'Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/enterprise-server@3.9/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/enterprise-server@3.9/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.' tags: - Runs operationId: listCheckRunsForGitReference externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/checks/runs#list-check-runs-for-a-git-reference parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/commit-ref' - $ref: '#/components/parameters/check-name' - $ref: '#/components/parameters/status' - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. in: query required: false schema: type: string enum: - latest - all default: latest example: latest - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' - name: app_id in: query required: false schema: type: integer example: 42 - 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: object required: - total_count - check_runs properties: total_count: type: integer check_runs: type: array items: $ref: '#/components/schemas/check-run' examples: default: $ref: '#/components/examples/check-run-paginated' headers: Link: $ref: '#/components/headers/link' x-github: githubCloudOnly: false enabledForGitHubApps: true category: checks subcategory: runs security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK components: schemas: nullable-simple-user: 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 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 check-annotation: title: Check Annotation description: Check Annotation type: object properties: path: type: string example: README.md start_line: type: integer example: 2 end_line: type: integer example: 2 start_column: type: integer example: 5 end_column: type: integer example: 10 annotation_level: type: string example: warning title: type: string example: Spell Checker message: type: string example: Check your spelling for 'banaas'. raw_details: type: string example: Do you mean 'bananas' or 'banana'? blob_href: type: string example: https://api.github.com/repos/octocat/Hello-World required: - path - blob_href - start_line - end_line - start_column - end_column - annotation_level - title - message - raw_details pull-request-minimal: title: Pull Request Minimal type: object properties: id: type: integer format: int64 example: 42 number: type: integer example: 42 url: type: string example: https://api.github.com/repos/octocat/Hello-World head: type: object properties: ref: type: string sha: type: string repo: type: object properties: id: type: integer format: int64 url: type: string name: type: string required: - id - url - name required: - ref - sha - repo base: type: object properties: ref: type: string sha: type: string repo: type: object properties: id: type: integer format: int64 url: type: string name: type: string required: - id - url - name required: - ref - sha - repo required: - id - number - url - head - base nullable-integration: title: GitHub app description: GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object properties: id: description: Unique identifier of the GitHub app example: 37 type: integer slug: description: The slug name of the GitHub app example: probot-owners type: string node_id: type: string example: MDExOkludGVncmF0aW9uMQ== owner: $ref: '#/components/schemas/nullable-simple-user' name: description: The name of the GitHub app example: Probot Owners type: string description: type: string example: The description of the app. external_url: type: string format: uri example: https://example.com html_url: type: string format: uri example: https://github.com/apps/super-ci created_at: type: string format: date-time example: '2017-07-08T16:18:44-04:00' updated_at: type: string format: date-time example: '2017-07-08T16:18:44-04:00' permissions: description: The set of permissions for the GitHub app type: object properties: issues: type: string checks: type: string metadata: type: string contents: type: string deployments: type: string additionalProperties: type: string example: issues: read deployments: write events: description: The list of events for the GitHub app example: - label - deployment type: array items: type: string installations_count: description: The number of installations associated with the GitHub app example: 5 type: integer client_id: type: string example: '"Iv1.25b5d1e65ffc4022"' client_secret: type: string example: '"1d4b2097ac622ba702d19de498f005747a8b21d3"' webhook_secret: type: string example: '"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b"' pem: type: string example: '"-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n"' required: - id - node_id - owner - name - description - external_url - html_url - created_at - updated_at - permissions - events code-of-conduct: title: Code Of Conduct description: Code Of Conduct type: object properties: key: type: string example: contributor_covenant name: type: string example: Contributor Covenant url: type: string format: uri example: https://api.github.com/codes_of_conduct/contributor_covenant body: type: string example: "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" html_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World required: - url - html_url - key - name deployment: title: Deployment description: request for a specific ref(branch,sha,tag) to be deployed type: object properties: url: type: string format: uri example: https://api.github.com/repos/octocat/example/deployments/1 id: description: Unique identifier of the deployment type: integer format: int64 example: 42 node_id: type: string example: MDEwOkRlcGxveW1lbnQx sha: type: string example: a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d ref: description: The ref to deploy. This can be a branch, tag, or sha. example: topic-branch type: string task: description: Parameter to specify a task to execute example: deploy type: string payload: oneOf: - type: object additionalProperties: true - type: string example: example_value original_environment: type: string example: staging environment: description: Name for the target deployment environment. example: production type: string description: type: string example: Deploy request from hubot creator: $ref: '#/components/schemas/nullable-simple-user' created_at: type: string format: date-time example: '2012-07-20T01:19:13Z' updated_at: type: string format: date-time example: '2012-07-20T01:19:13Z' statuses_url: type: string format: uri example: https://api.github.com/repos/octocat/example/deployments/1/statuses repository_url: type: string format: uri example: https://api.github.com/repos/octocat/example transient_environment: description: 'Specifies if the given environment is will no longer exist at some point in the future. Default: false.' example: true type: boolean production_environment: description: 'Specifies if the given environment is one that end-users directly interact with. Default: false.' example: true type: boolean performed_via_github_app: $ref: '#/components/schemas/nullable-integration' required: - id - node_id - sha - ref - task - environment - creator - payload - description - statuses_url - repository_url - url - created_at - updated_at 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 artifact: title: Artifact description: An artifact type: object properties: id: type: integer example: 5 node_id: type: string example: MDEwOkNoZWNrU3VpdGU1 name: description: The name of the artifact. type: string example: AdventureWorks.Framework size_in_bytes: description: The size in bytes of the artifact. type: integer example: 12345 url: type: string example: https://api.github.com/repos/github/hello-world/actions/artifacts/5 archive_download_url: type: string example: https://api.github.com/repos/github/hello-world/actions/artifacts/5/zip expired: description: Whether or not the artifact has expired. type: boolean example: true created_at: type: string format: date-time example: '2026-04-17T12:00:00Z' expires_at: type: string format: date-time example: '2026-04-17T12:00:00Z' updated_at: type: string format: date-time example: '2026-04-17T12:00:00Z' workflow_run: type: object properties: id: example: 10 type: integer repository_id: example: 42 type: integer head_repository_id: example: 42 type: integer head_branch: example: main type: string head_sha: example: 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d type: string required: - id - node_id - name - size_in_bytes - url - archive_download_url - expired - created_at - expires_at - updated_at job: title: Job description: Information of a job execution in a workflow run type: object properties: id: description: The id of the job. example: 21 type: integer run_id: description: The id of the associated workflow run. example: 5 type: integer run_url: type: string example: https://api.github.com/repos/github/hello-world/actions/runs/5 run_attempt: type: integer description: Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run. example: 1 node_id: type: string example: MDg6Q2hlY2tSdW40 head_sha: description: The SHA of the commit that is being run. example: 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d type: string url: type: string example: https://api.github.com/repos/github/hello-world/actions/jobs/21 html_url: type: string example: https://github.com/github/hello-world/runs/4 status: description: The phase of the lifecycle that the job is currently in. example: queued type: string enum: - queued - in_progress - completed - waiting - requested - pending conclusion: description: The outcome of the job. example: success type: string enum: - success - failure - neutral - cancelled - skipped - timed_out - action_required created_at: description: The time that the job created, in ISO 8601 format. example: '2019-08-08T08:00:00-07:00' format: date-time type: string started_at: description: The time that the job started, in ISO 8601 format. example: '2019-08-08T08:00:00-07:00' format: date-time type: string completed_at: description: The time that the job finished, in ISO 8601 format. example: '2019-08-08T08:00:00-07:00' format: date-time type: string name: description: The name of the job. example: test-coverage type: string steps: description: Steps in this job. type: array items: type: object required: - name - status - conclusion - number properties: status: description: The phase of the lifecycle that the job is currently in. example: queued type: string enum: - queued - in_progress - completed conclusion: description: The outcome of the job. example: success type: string name: description: The name of the job. example: test-coverage type: string number: type: integer example: 1 started_at: description: The time that the step started, in ISO 8601 format. example: '2019-08-08T08:00:00-07:00' format: date-time type: string completed_at: description: The time that the job finished, in ISO 8601 format. example: '2019-08-08T08:00:00-07:00' format: date-time type: string check_run_url: type: string example: https://api.github.com/repos/github/hello-world/check-runs/4 labels: type: array items: type: string description: Labels for the workflow job. Specified by the "runs_on" attribute in the action's workflow file. example: - self-hosted - foo - bar runner_id: type: integer example: 1 description: The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) runner_name: type: string example: my runner description: The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) runner_group_id: type: integer example: 2 description: The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) runner_group_name: type: string example: my runner group description: The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) workflow_name: type: string description: The name of the workflow. example: Build head_branch: type: string description: The name of the current branch. example: main required: - id - node_id - run_id - run_url - head_sha - workflow_name - head_branch - name - url - html_url - status - conclusion - started_at - completed_at - check_run_url - labels - runner_id - runner_name - runner_group_id - runner_group_name - created_at environment-approvals: title: Environment Approval description: An entry in the reviews log for environment deployments type: object properties: environments: description: The list of environments that were approved or rejected type: array items: type: object properties: id: description: The id of the environment. example: 56780428 type: integer node_id: type: string example: MDExOkVudmlyb25tZW50NTY3ODA0Mjg= name: description: The name of the environment. example: staging type: string url: type: string example: https://api.github.com/repos/github/hello-world/environments/staging html_url: type: string example: https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging created_at: description: The time that the environment was created, in ISO 8601 format. example: '2020-11-23T22:00:40Z' format: date-time type: string updated_at: description: The time that the environment was last updated, in ISO 8601 format. example: '2020-11-23T22:00:40Z' format: date-time type: string state: description: Whether deployment to the environment(s) was approved or rejected or pending (with comments) enum: - approved - rejected - pending example: approved type: string user: $ref: '#/components/schemas/simple-user' comment: type: string description: The comment submitted with the deployment review example: Ship it! required: - environments - state - user - comment deployment-simple: title: Deployment description: deployment created as the result of an Actions check run from a workflow that references an environment type: object properties: url: type: string format: uri example: https://api.github.com/repos/octocat/example/deployments/1 id: description: Unique identifier of the deployment example: 42 type: integer node_id: type: string example: MDEwOkRlcGxveW1lbnQx task: description: Parameter to specify a task to execute example: deploy type: string original_environment: type: string example: staging environment: description: Name for the target deployment environment. example: production type: string description: type: string example: Deploy request from hubot created_at: type: string format: date-time example: '2012-07-20T01:19:13Z' updated_at: type: string format: date-time example: '2012-07-20T01:19:13Z' statuses_url: type: string format: uri example: https://api.github.com/repos/octocat/example/deployments/1/statuses repository_url: type: string format: uri example: https://api.github.com/repos/octocat/example transient_environment: description: 'Specifies if the given environment is will no longer exist at some point in the future. Default: false.' example: true type: boolean production_environment: description: 'Specifies if the given environment is one that end-users directly interact with. Default: false.' example: true type: boolean performed_via_github_app: $ref: '#/components/schemas/nullable-integration' required: - id - node_id - task - environment - description - statuses_url - repository_url - url - created_at - updated_at nullable-simple-commit: title: Simple Commit description: commit. type: object properties: id: type: string description: SHA for the commit example: 7638417db6d59f3c431d3e1f261cc637155684cd tree_id: type: string description: SHA for the commit's tree example: '12345678' message: description: Message describing the purpose of the commit example: 'Fix #42' type: string timestamp: description: Timestamp of the commit example: '2014-08-09T08:02:04+12:00' format: date-time type: string author: type: object description: Information about the Git author properties: name: description: Name of the commit's author example: Monalisa Octocat type: string email: description: Git email address of the commit's author example: monalisa.octocat@example.com type: string format: email required: - name - email committer: type: object description: Information about the Git committer properties: name: description: Name of the commit's committer example: Monalisa Octocat type: string email: description: Git email address of the commit's committer example: monalisa.octocat@example.com type: string format: email required: - name - email required: - id - tree_id - message - timestamp - author - committer team: title: Team description: Groups of organization members that gives permissions on specified repositories. type: object properties: id: type: integer example: 42 node_id: type: string example: '12345678' name: type: string example: octocat slug: type: string example: example_value description: type: string example: This is an example repository privacy: type: string example: example_value permission: type: string example: example_value permissions: type: object properties: pull: type: boolean triage: type: boolean push: type: boolean maintain: type: boolean admin: type: boolean required: - pull - triage - push - maintain - admin url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World html_url: type: string format: uri example: https://github.com/orgs/rails/teams/core members_url: type: string example: https://api.github.com/repos/octocat/Hello-World repositories_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World parent: $ref: '#/components/schemas/nullable-team-simple' required: - id - node_id - url - members_url - name - description - permission - html_url - repositories_url - slug - parent 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 minimal-repository: title: Minimal Repository description: Minimal Repository type: object properties: id: type: integer format: int64 example: 1296269 node_id: type: string example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 name: type: string example: Hello-World full_name: type: string example: octocat/Hello-World owner: $ref: '#/components/schemas/simple-user_2' private: type: boolean example: true html_url: type: string format: uri example: https://github.com/octocat/Hello-World description: type: string example: This your first repo! fork: type: boolean example: true url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World archive_url: type: string example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} assignees_url: type: string example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} blobs_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} branches_url: type: string example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} collaborators_url: type: string example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} comments_url: type: string example: http://api.github.com/repos/octocat/Hello-World/comments{/number} commits_url: type: string example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} compare_url: type: string example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} contents_url: type: string example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} contributors_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/contributors deployments_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/deployments downloads_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/downloads events_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/events forks_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/forks git_commits_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} git_refs_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} git_tags_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} git_url: type: string issue_comment_url: type: string example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} issue_events_url: type: string example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} issues_url: type: string example: http://api.github.com/repos/octocat/Hello-World/issues{/number} keys_url: type: string example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} labels_url: type: string example: http://api.github.com/repos/octocat/Hello-World/labels{/name} languages_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/languages merges_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/merges milestones_url: type: string example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} notifications_url: type: string example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} pulls_url: type: string example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} releases_url: type: string example: http://api.github.com/repos/octocat/Hello-World/releases{/id} ssh_url: type: string stargazers_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/stargazers statuses_url: type: string example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} subscribers_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/subscribers subscription_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/subscription tags_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/tags teams_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/teams trees_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} clone_url: type: string mirror_url: type: string hooks_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/hooks svn_url: type: string homepage: type: string language: type: string forks_count: type: integer stargazers_count: type: integer watchers_count: type: integer size: description: The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. type: integer default_branch: type: string open_issues_count: type: integer is_template: type: boolean topics: type: array items: type: string has_issues: type: boolean has_projects: type: boolean has_wiki: type: boolean has_pages: type: boolean has_downloads: type: boolean has_discussions: type: boolean archived: type: boolean disabled: type: boolean visibility: type: string pushed_at: type: string format: date-time example: '2011-01-26T19:06:43Z' created_at: type: string format: date-time example: '2011-01-26T19:01:12Z' updated_at: type: string format: date-time example: '2011-01-26T19:14:43Z' permissions: type: object properties: admin: type: boolean maintain: type: boolean push: type: boolean triage: type: boolean pull: type: boolean role_name: type: string example: admin temp_clone_token: type: string delete_branch_on_merge: type: boolean subscribers_count: type: integer network_count: type: integer code_of_conduct: $ref: '#/components/schemas/code-of-conduct' license: type: object properties: key: type: string name: type: string spdx_id: type: string url: type: string node_id: type: string forks: type: integer example: 0 open_issues: type: integer example: 0 watchers: type: integer example: 0 allow_forking: type: boolean web_commit_signoff_required: type: boolean example: false security_and_analysis: $ref: '#/components/schemas/security-and-analysis' required: - archive_url - assignees_url - blobs_url - branches_url - collaborators_url - comments_url - commits_url - compare_url - contents_url - contributors_url - deployments_url - description - downloads_url - events_url - fork - forks_url - full_name - git_commits_url - git_refs_url - git_tags_url - hooks_url - html_url - id - node_id - issue_comment_url - issue_events_url - issues_url - keys_url - labels_url - languages_url - merges_url - milestones_url - name - notifications_url - owner - private - pulls_url - releases_url - stargazers_url - statuses_url - subscribers_url - subscription_url - tags_url - teams_url - trees_url - url empty-object: title: Empty Object description: An object without any properties. type: object additionalProperties: false nullable-team-simple: title: Team Simple description: Groups of organization members that gives permissions on specified repositories. type: object properties: id: description: Unique identifier of the team type: integer example: 1 node_id: type: string example: MDQ6VGVhbTE= url: description: URL for the team type: string format: uri example: https://api.github.com/organizations/1/team/1 members_url: type: string example: https://api.github.com/organizations/1/team/1/members{/member} name: description: Name of the team type: string example: Justice League description: description: Description of the team type: string example: great team. permission: description: Permission that the team will have for its repositories type: string example: admin privacy: description: The level of privacy this team should have type: string example: closed html_url: type: string format: uri example: https://github.com/orgs/rails/teams/core repositories_url: type: string format: uri example: https://api.github.com/organizations/1/team/1/repos slug: type: string example: justice-league ldap_dn: description: Distinguished Name (DN) that team maps to within LDAP environment example: uid=example,ou=users,dc=github,dc=com type: string required: - id - node_id - url - members_url - name - description - permission - html_url - repositories_url - slug deployment-reviewer-type: type: string description: The type of reviewer. enum: - User - Team example: User check-run: title: CheckRun description: check performed on the code of a given code change type: object properties: id: description: The id of the check. example: 21 type: integer head_sha: description: The SHA of the commit that is being checked. example: 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d type: string node_id: type: string example: MDg6Q2hlY2tSdW40 external_id: type: string example: '42' url: type: string example: https://api.github.com/repos/github/hello-world/check-runs/4 html_url: type: string example: https://github.com/github/hello-world/runs/4 details_url: type: string example: https://example.com status: description: The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs. example: queued type: string enum: - queued - in_progress - completed - waiting - requested - pending conclusion: type: string example: neutral enum: - success - failure - neutral - cancelled - skipped - timed_out - action_required started_at: type: string format: date-time example: '2018-05-04T01:14:52Z' completed_at: type: string format: date-time example: '2018-05-04T01:14:52Z' output: type: object properties: title: type: string summary: type: string text: type: string annotations_count: type: integer annotations_url: type: string format: uri required: - title - summary - text - annotations_count - annotations_url name: description: The name of the check. example: test-coverage type: string check_suite: type: object properties: id: type: integer required: - id app: $ref: '#/components/schemas/nullable-integration' pull_requests: description: Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check. type: array items: $ref: '#/components/schemas/pull-request-minimal' deployment: $ref: '#/components/schemas/deployment-simple' required: - id - node_id - head_sha - name - url - html_url - details_url - status - conclusion - started_at - completed_at - external_id - check_suite - output - app - pull_requests security-and-analysis: type: object properties: advanced_security: type: object properties: status: type: string enum: - enabled - disabled secret_scanning: type: object properties: status: type: string enum: - enabled - disabled secret_scanning_push_protection: type: object properties: status: type: string enum: - enabled - disabled pending-deployment: title: Pending Deployment description: Details of a deployment that is waiting for protection rules to pass type: object properties: environment: type: object properties: id: description: The id of the environment. type: integer format: int64 example: 56780428 node_id: type: string example: MDExOkVudmlyb25tZW50NTY3ODA0Mjg= name: description: The name of the environment. example: staging type: string url: type: string example: https://api.github.com/repos/github/hello-world/environments/staging html_url: type: string example: https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging wait_timer: type: integer description: The set duration of the wait timer example: 30 wait_timer_started_at: description: The time that the wait timer began. example: '2020-11-23T22:00:40Z' format: date-time type: string current_user_can_approve: description: Whether the currently authenticated user can approve the deployment type: boolean example: true reviewers: type: array description: The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. items: type: object properties: type: $ref: '#/components/schemas/deployment-reviewer-type' reviewer: anyOf: - $ref: '#/components/schemas/simple-user_2' - $ref: '#/components/schemas/team' required: - environment - wait_timer - wait_timer_started_at - current_user_can_approve - reviewers referenced-workflow: title: Referenced workflow description: workflow referenced/reused by the initial caller workflow type: object properties: path: type: string example: src/index.js sha: type: string example: abc123def456789012345678901234567890 ref: type: string example: main required: - path - sha workflow-run: title: Workflow Run description: An invocation of a workflow type: object properties: id: type: integer description: The ID of the workflow run. example: 5 name: type: string description: The name of the workflow run. example: Build node_id: type: string example: MDEwOkNoZWNrU3VpdGU1 check_suite_id: type: integer description: The ID of the associated check suite. example: 42 check_suite_node_id: type: string description: The node ID of the associated check suite. example: MDEwOkNoZWNrU3VpdGU0Mg== head_branch: type: string example: master head_sha: description: The SHA of the head commit that points to the version of the workflow being run. example: 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d type: string path: description: The full path of the workflow example: octocat/octo-repo/.github/workflows/ci.yml@main type: string run_number: type: integer description: The auto incrementing run number for the workflow run. example: 106 run_attempt: type: integer description: Attempt number of the run, 1 for first attempt and higher if the workflow was re-run. example: 1 referenced_workflows: type: array items: $ref: '#/components/schemas/referenced-workflow' event: type: string example: push status: type: string example: completed conclusion: type: string example: neutral workflow_id: type: integer description: The ID of the parent workflow. example: 5 url: type: string description: The URL to the workflow run. example: https://api.github.com/repos/github/hello-world/actions/runs/5 html_url: type: string example: https://github.com/github/hello-world/suites/4 pull_requests: description: Pull requests that are open with a `head_sha` or `head_branch` that matches the workflow run. The returned pull requests do not necessarily indicate pull requests that triggered the run. type: array items: $ref: '#/components/schemas/pull-request-minimal' created_at: type: string format: date-time example: '2026-04-17T12:00:00Z' updated_at: type: string format: date-time example: '2026-04-17T12:00:00Z' actor: $ref: '#/components/schemas/simple-user_2' triggering_actor: $ref: '#/components/schemas/simple-user_2' run_started_at: type: string format: date-time description: The start time of the latest run. Resets on re-run. jobs_url: description: The URL to the jobs for the workflow run. type: string example: https://api.github.com/repos/github/hello-world/actions/runs/5/jobs logs_url: description: The URL to download the logs for the workflow run. type: string example: https://api.github.com/repos/github/hello-world/actions/runs/5/logs check_suite_url: description: The URL to the associated check suite. type: string example: https://api.github.com/repos/github/hello-world/check-suites/12 artifacts_url: description: The URL to the artifacts for the workflow run. type: string example: https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts cancel_url: description: The URL to cancel the workflow run. type: string example: https://api.github.com/repos/github/hello-world/actions/runs/5/cancel rerun_url: description: The URL to rerun the workflow run. type: string example: https://api.github.com/repos/github/hello-world/actions/runs/5/rerun previous_attempt_url: description: The URL to the previous attempted run of this workflow, if one exists. type: string example: https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3 workflow_url: description: The URL to the workflow. type: string example: https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml head_commit: $ref: '#/components/schemas/nullable-simple-commit' repository: $ref: '#/components/schemas/minimal-repository' head_repository: $ref: '#/components/schemas/minimal-repository' head_repository_id: type: integer example: 5 display_title: type: string example: Simple Workflow description: The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow. required: - id - node_id - head_branch - run_number - display_title - event - status - conclusion - head_sha - path - workflow_id - url - html_url - created_at - updated_at - head_commit - head_repository - repository - jobs_url - logs_url - check_suite_url - cancel_url - rerun_url - artifacts_url - workflow_url - pull_requests examples: check-annotation-items: value: - path: README.md start_line: 2 end_line: 2 start_column: 5 end_column: 10 annotation_level: warning title: Spell Checker message: Check your spelling for 'banaas'. raw_details: Do you mean 'bananas' or 'banana'? blob_href: https://api.github.com/repos/github/rest-api-description/git/blobs/abc job-paginated: value: total_count: 1 jobs: - id: 399444496 run_id: 29679449 run_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449 node_id: MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng== head_sha: f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0 url: https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496 html_url: https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496 status: completed conclusion: success started_at: '2020-01-20T17:42:40Z' completed_at: '2020-01-20T17:44:39Z' created_at: '2020-01-20T17:44:39Z' name: build steps: - name: Set up job status: completed conclusion: success number: 1 started_at: '2020-01-20T09:42:40.000-08:00' completed_at: '2020-01-20T09:42:41.000-08:00' - name: Run actions/checkout@v2 status: completed conclusion: success number: 2 started_at: '2020-01-20T09:42:41.000-08:00' completed_at: '2020-01-20T09:42:45.000-08:00' - name: Set up Ruby status: completed conclusion: success number: 3 started_at: '2020-01-20T09:42:45.000-08:00' completed_at: '2020-01-20T09:42:45.000-08:00' - name: Run actions/cache@v3 status: completed conclusion: success number: 4 started_at: '2020-01-20T09:42:45.000-08:00' completed_at: '2020-01-20T09:42:48.000-08:00' - name: Install Bundler status: completed conclusion: success number: 5 started_at: '2020-01-20T09:42:48.000-08:00' completed_at: '2020-01-20T09:42:52.000-08:00' - name: Install Gems status: completed conclusion: success number: 6 started_at: '2020-01-20T09:42:52.000-08:00' completed_at: '2020-01-20T09:42:53.000-08:00' - name: Run Tests status: completed conclusion: success number: 7 started_at: '2020-01-20T09:42:53.000-08:00' completed_at: '2020-01-20T09:42:59.000-08:00' - name: Deploy to Heroku status: completed conclusion: success number: 8 started_at: '2020-01-20T09:42:59.000-08:00' completed_at: '2020-01-20T09:44:39.000-08:00' - name: Post actions/cache@v3 status: completed conclusion: success number: 16 started_at: '2020-01-20T09:44:39.000-08:00' completed_at: '2020-01-20T09:44:39.000-08:00' - name: Complete job status: completed conclusion: success number: 17 started_at: '2020-01-20T09:44:39.000-08:00' completed_at: '2020-01-20T09:44:39.000-08:00' check_run_url: https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496 labels: - self-hosted - foo - bar runner_id: 1 runner_name: my runner runner_group_id: 2 runner_group_name: my runner group workflow_name: CI head_branch: main environment-approvals-items: value: - state: approved comment: Ship it! environments: - id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 name: staging url: https://api.github.com/repos/github/hello-world/environments/staging html_url: https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging created_at: '2020-11-23T22:00:40Z' updated_at: '2020-11-23T22:00:40Z' user: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false artifact-paginated: value: total_count: 2 artifacts: - id: 11 node_id: MDg6QXJ0aWZhY3QxMQ== name: Rails size_in_bytes: 556 url: https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11 archive_download_url: https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip expired: false created_at: '2020-01-10T14:59:22Z' expires_at: '2020-03-21T14:59:22Z' updated_at: '2020-02-21T14:59:22Z' workflow_run: id: 2332938 repository_id: 1296269 head_repository_id: 1296269 head_branch: main head_sha: 328faa0536e6fef19753d9d91dc96a9931694ce3 - id: 13 node_id: MDg6QXJ0aWZhY3QxMw== name: Test output size_in_bytes: 453 url: https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13 archive_download_url: https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13/zip expired: false created_at: '2020-01-10T14:59:22Z' expires_at: '2020-03-21T14:59:22Z' updated_at: '2020-02-21T14:59:22Z' workflow_run: id: 2332942 repository_id: 1296269 head_repository_id: 1296269 head_branch: main head_sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 job: value: id: 399444496 run_id: 29679449 run_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449 node_id: MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng== head_sha: f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0 url: https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496 html_url: https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496 status: completed conclusion: success started_at: '2020-01-20T17:42:40Z' completed_at: '2020-01-20T17:44:39Z' created_at: '2020-01-20T17:44:39Z' name: build steps: - name: Set up job status: completed conclusion: success number: 1 started_at: '2020-01-20T09:42:40.000-08:00' completed_at: '2020-01-20T09:42:41.000-08:00' - name: Run actions/checkout@v2 status: completed conclusion: success number: 2 started_at: '2020-01-20T09:42:41.000-08:00' completed_at: '2020-01-20T09:42:45.000-08:00' - name: Set up Ruby status: completed conclusion: success number: 3 started_at: '2020-01-20T09:42:45.000-08:00' completed_at: '2020-01-20T09:42:45.000-08:00' - name: Run actions/cache@v3 status: completed conclusion: success number: 4 started_at: '2020-01-20T09:42:45.000-08:00' completed_at: '2020-01-20T09:42:48.000-08:00' - name: Install Bundler status: completed conclusion: success number: 5 started_at: '2020-01-20T09:42:48.000-08:00' completed_at: '2020-01-20T09:42:52.000-08:00' - name: Install Gems status: completed conclusion: success number: 6 started_at: '2020-01-20T09:42:52.000-08:00' completed_at: '2020-01-20T09:42:53.000-08:00' - name: Run Tests status: completed conclusion: success number: 7 started_at: '2020-01-20T09:42:53.000-08:00' completed_at: '2020-01-20T09:42:59.000-08:00' - name: Deploy to Heroku status: completed conclusion: success number: 8 started_at: '2020-01-20T09:42:59.000-08:00' completed_at: '2020-01-20T09:44:39.000-08:00' - name: Post actions/cache@v3 status: completed conclusion: success number: 16 started_at: '2020-01-20T09:44:39.000-08:00' completed_at: '2020-01-20T09:44:39.000-08:00' - name: Complete job status: completed conclusion: success number: 17 started_at: '2020-01-20T09:44:39.000-08:00' completed_at: '2020-01-20T09:44:39.000-08:00' check_run_url: https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496 labels: - self-hosted - foo - bar runner_id: 1 runner_name: my runner runner_group_id: 2 runner_group_name: my runner group workflow_name: CI head_branch: main workflow-run: value: id: 30433642 name: Build node_id: MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ== check_suite_id: 42 check_suite_node_id: MDEwOkNoZWNrU3VpdGU0Mg== head_branch: main head_sha: acb5820ced9479c074f688cc328bf03f341a511d path: .github/workflows/build.yml@main run_number: 562 event: push display_title: Update README.md status: queued conclusion: success workflow_id: 159038 url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642 html_url: https://github.com/octo-org/octo-repo/actions/runs/30433642 pull_requests: [] created_at: '2020-01-22T19:33:08Z' updated_at: '2020-01-22T19:33:08Z' actor: 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 run_attempt: 1 referenced_workflows: - path: octocat/Hello-World/.github/workflows/deploy.yml@main sha: 86e8bc9ecf7d38b1ed2d2cfb8eb87ba9b35b01db ref: refs/heads/main - path: octo-org/octo-repo/.github/workflows/report.yml@v2 sha: 79e9790903e1c3373b1a3e3a941d57405478a232 ref: refs/tags/v2 - path: octo-org/octo-repo/.github/workflows/secure.yml@1595d4b6de6a9e9751fb270a41019ce507d4099e sha: 1595d4b6de6a9e9751fb270a41019ce507d4099e run_started_at: '2020-01-22T19:33:08Z' triggering_actor: 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 jobs_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs logs_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs check_suite_url: https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374 artifacts_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts cancel_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel rerun_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun previous_attempt_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/attempts/1 workflow_url: https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038 head_commit: id: acb5820ced9479c074f688cc328bf03f341a511d tree_id: d23f6eedb1e1b9610bbc754ddb5197bfe7271223 message: Create linter.yaml timestamp: '2020-01-22T19:33:05Z' author: name: Octo Cat email: octocat@github.com committer: name: GitHub email: noreply@github.com repository: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 name: Hello-World full_name: octocat/Hello-World owner: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false private: false html_url: https://github.com/octocat/Hello-World description: This your first repo! fork: false url: https://api.github.com/repos/octocat/Hello-World archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads events_url: https://api.github.com/repos/octocat/Hello-World/events forks_url: https://api.github.com/repos/octocat/Hello-World/forks git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} git_url: git:github.com/octocat/Hello-World.git issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} languages_url: https://api.github.com/repos/octocat/Hello-World/languages merges_url: https://api.github.com/repos/octocat/Hello-World/merges milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} ssh_url: git@github.com:octocat/Hello-World.git stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription tags_url: https://api.github.com/repos/octocat/Hello-World/tags teams_url: https://api.github.com/repos/octocat/Hello-World/teams trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks head_repository: id: 217723378 node_id: MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg= name: octo-repo full_name: octo-org/octo-repo private: true 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 html_url: https://github.com/octo-org/octo-repo description: '' fork: false url: https://api.github.com/repos/octo-org/octo-repo forks_url: https://api.github.com/repos/octo-org/octo-repo/forks keys_url: https://api.github.com/repos/octo-org/octo-repo/keys{/key_id} collaborators_url: https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator} teams_url: https://api.github.com/repos/octo-org/octo-repo/teams hooks_url: https://api.github.com/repos/octo-org/octo-repo/hooks issue_events_url: https://api.github.com/repos/octo-org/octo-repo/issues/events{/number} events_url: https://api.github.com/repos/octo-org/octo-repo/events assignees_url: https://api.github.com/repos/octo-org/octo-repo/assignees{/user} branches_url: https://api.github.com/repos/octo-org/octo-repo/branches{/branch} tags_url: https://api.github.com/repos/octo-org/octo-repo/tags blobs_url: https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha} git_tags_url: https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha} git_refs_url: https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha} trees_url: https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha} statuses_url: https://api.github.com/repos/octo-org/octo-repo/statuses/{sha} languages_url: https://api.github.com/repos/octo-org/octo-repo/languages stargazers_url: https://api.github.com/repos/octo-org/octo-repo/stargazers contributors_url: https://api.github.com/repos/octo-org/octo-repo/contributors subscribers_url: https://api.github.com/repos/octo-org/octo-repo/subscribers subscription_url: https://api.github.com/repos/octo-org/octo-repo/subscription commits_url: https://api.github.com/repos/octo-org/octo-repo/commits{/sha} git_commits_url: https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha} comments_url: https://api.github.com/repos/octo-org/octo-repo/comments{/number} issue_comment_url: https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number} contents_url: https://api.github.com/repos/octo-org/octo-repo/contents/{+path} compare_url: https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head} merges_url: https://api.github.com/repos/octo-org/octo-repo/merges archive_url: https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref} downloads_url: https://api.github.com/repos/octo-org/octo-repo/downloads issues_url: https://api.github.com/repos/octo-org/octo-repo/issues{/number} pulls_url: https://api.github.com/repos/octo-org/octo-repo/pulls{/number} 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} labels_url: https://api.github.com/repos/octo-org/octo-repo/labels{/name} releases_url: https://api.github.com/repos/octo-org/octo-repo/releases{/id} deployments_url: https://api.github.com/repos/octo-org/octo-repo/deployments check-run-paginated: value: total_count: 1 check_runs: - id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 node_id: MDg6Q2hlY2tSdW40 external_id: '' url: https://api.github.com/repos/github/hello-world/check-runs/4 html_url: https://github.com/github/hello-world/runs/4 details_url: https://example.com status: completed conclusion: neutral started_at: '2018-05-04T01:14:52Z' completed_at: '2018-05-04T01:14:52Z' output: title: Mighty Readme report summary: There are 0 failures, 2 warnings, and 1 notice. text: You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app. annotations_count: 2 annotations_url: https://api.github.com/repos/github/hello-world/check-runs/4/annotations name: mighty_readme check_suite: id: 5 app: id: 1 slug: octoapp node_id: MDExOkludGVncmF0aW9uMQ== owner: login: github id: 1 node_id: MDEyOk9yZ2FuaXphdGlvbjE= url: https://api.github.com/orgs/github repos_url: https://api.github.com/orgs/github/repos events_url: https://api.github.com/orgs/github/events avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' 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 received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: true name: Octocat App description: '' external_url: https://example.com html_url: https://github.com/apps/octoapp created_at: '2017-07-08T16:18:44-04:00' updated_at: '2017-07-08T16:18:44-04:00' permissions: metadata: read contents: read issues: write single_file: write events: - push - pull_request pull_requests: - url: https://api.github.com/repos/github/hello-world/pulls/1 id: 1934 number: 3956 head: ref: say-hello sha: 3dca65fa3e8d4b3da3f3d056c59aee1c50f41390 repo: id: 526 url: https://api.github.com/repos/github/hello-world name: hello-world base: ref: master sha: e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f repo: id: 526 url: https://api.github.com/repos/github/hello-world name: hello-world check-run: value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 node_id: MDg6Q2hlY2tSdW40 external_id: '' url: https://api.github.com/repos/github/hello-world/check-runs/4 html_url: https://github.com/github/hello-world/runs/4 details_url: https://example.com status: completed conclusion: neutral started_at: '2018-05-04T01:14:52Z' completed_at: '2018-05-04T01:14:52Z' output: title: Mighty Readme report summary: There are 0 failures, 2 warnings, and 1 notice. text: You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app. annotations_count: 2 annotations_url: https://api.github.com/repos/github/hello-world/check-runs/4/annotations name: mighty_readme check_suite: id: 5 app: id: 1 slug: octoapp node_id: MDExOkludGVncmF0aW9uMQ== owner: login: github id: 1 node_id: MDEyOk9yZ2FuaXphdGlvbjE= url: https://api.github.com/orgs/github repos_url: https://api.github.com/orgs/github/repos events_url: https://api.github.com/orgs/github/events avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' 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 received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: true name: Octocat App description: '' external_url: https://example.com html_url: https://github.com/apps/octoapp created_at: '2017-07-08T16:18:44-04:00' updated_at: '2017-07-08T16:18:44-04:00' permissions: metadata: read contents: read issues: write single_file: write events: - push - pull_request pull_requests: - url: https://api.github.com/repos/github/hello-world/pulls/1 id: 1934 number: 3956 head: ref: say-hello sha: 3dca65fa3e8d4b3da3f3d056c59aee1c50f41390 repo: id: 526 url: https://api.github.com/repos/github/hello-world name: hello-world base: ref: master sha: e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f repo: id: 526 url: https://api.github.com/repos/github/hello-world name: hello-world deployment-items: value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 node_id: MDEwOkRlcGxveW1lbnQx sha: a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d ref: topic-branch task: deploy payload: {} original_environment: staging environment: production description: Deploy request from hubot creator: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false created_at: '2012-07-20T01:19:13Z' updated_at: '2012-07-20T01:19:13Z' statuses_url: https://api.github.com/repos/octocat/example/deployments/1/statuses repository_url: https://api.github.com/repos/octocat/example transient_environment: false production_environment: true pending-deployment-items: value: - environment: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 name: staging url: https://api.github.com/repos/github/hello-world/environments/staging html_url: https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging wait_timer: 30 wait_timer_started_at: '2020-11-23T22:00:40Z' current_user_can_approve: true reviewers: - type: User reviewer: 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 - type: Team reviewer: id: 1 node_id: MDQ6VGVhbTE= url: https://api.github.com/teams/1 html_url: https://github.com/orgs/github/teams/justice-league name: Justice League slug: justice-league description: great team. privacy: closed permission: admin members_url: https://api.github.com/teams/1/members{/member} repositories_url: https://api.github.com/teams/1/repos parent: id: 2 node_id: MDQ6VGVhbTE= url: https://api.github.com/teams/1 html_url: https://github.com/orgs/github/teams/justice-league name: Justice League slug: justice-league description: great team. privacy: closed permission: admin members_url: https://api.github.com/teams/1/members{/member} repositories_url: https://api.github.com/teams/1/repos workflow-run-paginated: value: total_count: 1 workflow_runs: - id: 30433642 name: Build node_id: MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ== check_suite_id: 42 check_suite_node_id: MDEwOkNoZWNrU3VpdGU0Mg== head_branch: master head_sha: acb5820ced9479c074f688cc328bf03f341a511d path: .github/workflows/build.yml@main run_number: 562 event: push display_title: Update README.md status: queued conclusion: success workflow_id: 159038 url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642 html_url: https://github.com/octo-org/octo-repo/actions/runs/30433642 pull_requests: [] created_at: '2020-01-22T19:33:08Z' updated_at: '2020-01-22T19:33:08Z' actor: 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 run_attempt: 1 run_started_at: '2020-01-22T19:33:08Z' triggering_actor: 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 jobs_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs logs_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs check_suite_url: https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374 artifacts_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts cancel_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel rerun_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun workflow_url: https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038 head_commit: id: acb5820ced9479c074f688cc328bf03f341a511d tree_id: d23f6eedb1e1b9610bbc754ddb5197bfe7271223 message: Create linter.yaml timestamp: '2020-01-22T19:33:05Z' author: name: Octo Cat email: octocat@github.com committer: name: GitHub email: noreply@github.com repository: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 name: Hello-World full_name: octocat/Hello-World owner: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false private: false html_url: https://github.com/octocat/Hello-World description: This your first repo! fork: false url: https://api.github.com/repos/octocat/Hello-World archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads events_url: https://api.github.com/repos/octocat/Hello-World/events forks_url: https://api.github.com/repos/octocat/Hello-World/forks git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} git_url: git:github.com/octocat/Hello-World.git issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} languages_url: https://api.github.com/repos/octocat/Hello-World/languages merges_url: https://api.github.com/repos/octocat/Hello-World/merges milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} ssh_url: git@github.com:octocat/Hello-World.git stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription tags_url: https://api.github.com/repos/octocat/Hello-World/tags teams_url: https://api.github.com/repos/octocat/Hello-World/teams trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks head_repository: id: 217723378 node_id: MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg= name: octo-repo full_name: octo-org/octo-repo private: true 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 html_url: https://github.com/octo-org/octo-repo description: '' fork: false url: https://api.github.com/repos/octo-org/octo-repo forks_url: https://api.github.com/repos/octo-org/octo-repo/forks keys_url: https://api.github.com/repos/octo-org/octo-repo/keys{/key_id} collaborators_url: https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator} teams_url: https://api.github.com/repos/octo-org/octo-repo/teams hooks_url: https://api.github.com/repos/octo-org/octo-repo/hooks issue_events_url: https://api.github.com/repos/octo-org/octo-repo/issues/events{/number} events_url: https://api.github.com/repos/octo-org/octo-repo/events assignees_url: https://api.github.com/repos/octo-org/octo-repo/assignees{/user} branches_url: https://api.github.com/repos/octo-org/octo-repo/branches{/branch} tags_url: https://api.github.com/repos/octo-org/octo-repo/tags blobs_url: https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha} git_tags_url: https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha} git_refs_url: https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha} trees_url: https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha} statuses_url: https://api.github.com/repos/octo-org/octo-repo/statuses/{sha} languages_url: https://api.github.com/repos/octo-org/octo-repo/languages stargazers_url: https://api.github.com/repos/octo-org/octo-repo/stargazers contributors_url: https://api.github.com/repos/octo-org/octo-repo/contributors subscribers_url: https://api.github.com/repos/octo-org/octo-repo/subscribers subscription_url: https://api.github.com/repos/octo-org/octo-repo/subscription commits_url: https://api.github.com/repos/octo-org/octo-repo/commits{/sha} git_commits_url: https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha} comments_url: https://api.github.com/repos/octo-org/octo-repo/comments{/number} issue_comment_url: https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number} contents_url: https://api.github.com/repos/octo-org/octo-repo/contents/{+path} compare_url: https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head} merges_url: https://api.github.com/repos/octo-org/octo-repo/merges archive_url: https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref} downloads_url: https://api.github.com/repos/octo-org/octo-repo/downloads issues_url: https://api.github.com/repos/octo-org/octo-repo/issues{/number} pulls_url: https://api.github.com/repos/octo-org/octo-repo/pulls{/number} 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} labels_url: https://api.github.com/repos/octo-org/octo-repo/labels{/name} releases_url: https://api.github.com/repos/octo-org/octo-repo/releases{/id} deployments_url: https://api.github.com/repos/octo-org/octo-repo/deployments check-run-example-of-in-progress-conclusion: summary: Response for in_progress conclusion value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 node_id: MDg6Q2hlY2tSdW40 external_id: '42' url: https://api.github.com/repos/github/hello-world/check-runs/4 html_url: https://github.com/github/hello-world/runs/4 details_url: https://example.com status: in_progress conclusion: success started_at: '2018-05-04T01:14:52Z' completed_at: '2018-05-04T01:14:52Z' output: title: Mighty Readme report summary: There are 0 failures, 2 warnings, and 1 notice. text: You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app. annotations_count: 2 annotations_url: https://api.github.com/repos/github/hello-world/check-runs/4/annotations name: mighty_readme check_suite: id: 5 app: id: 1 slug: octoapp node_id: MDExOkludGVncmF0aW9uMQ== owner: login: github id: 1 node_id: MDEyOk9yZ2FuaXphdGlvbjE= url: https://api.github.com/orgs/github repos_url: https://api.github.com/orgs/github/repos events_url: https://api.github.com/orgs/github/events avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' 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 received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: true name: Octocat App description: '' external_url: https://example.com html_url: https://github.com/apps/octoapp created_at: '2017-07-08T16:18:44-04:00' updated_at: '2017-07-08T16:18:44-04:00' permissions: metadata: read contents: read issues: write single_file: write events: - push - pull_request pull_requests: - url: https://api.github.com/repos/github/hello-world/pulls/1 id: 1934 number: 3956 head: ref: say-hello sha: 3dca65fa3e8d4b3da3f3d056c59aee1c50f41390 repo: id: 526 url: https://api.github.com/repos/github/hello-world name: hello-world base: ref: master sha: e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f repo: id: 526 url: https://api.github.com/repos/github/hello-world name: hello-world check-run-example-of-completed-conclusion: summary: Response for completed conclusion value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 node_id: MDg6Q2hlY2tSdW40 external_id: '42' url: https://api.github.com/repos/github/hello-world/check-runs/4 html_url: https://github.com/github/hello-world/runs/4 details_url: https://example.com status: completed conclusion: neutral started_at: '2018-05-04T01:14:52Z' completed_at: '2018-05-04T01:14:52Z' output: title: Mighty Readme report summary: There are 0 failures, 2 warnings, and 1 notice. text: You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app. annotations_count: 2 annotations_url: https://api.github.com/repos/github/hello-world/check-runs/4/annotations name: mighty_readme check_suite: id: 5 app: id: 1 slug: octoapp node_id: MDExOkludGVncmF0aW9uMQ== owner: login: github id: 1 node_id: MDEyOk9yZ2FuaXphdGlvbjE= url: https://api.github.com/orgs/github repos_url: https://api.github.com/orgs/github/repos events_url: https://api.github.com/orgs/github/events avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' 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 received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: true name: Octocat App description: '' external_url: https://example.com html_url: https://github.com/apps/octoapp created_at: '2017-07-08T16:18:44-04:00' updated_at: '2017-07-08T16:18:44-04:00' permissions: metadata: read contents: read issues: write single_file: write events: - push - pull_request pull_requests: - url: https://api.github.com/repos/github/hello-world/pulls/1 id: 1934 number: 3956 head: ref: say-hello sha: 3dca65fa3e8d4b3da3f3d056c59aee1c50f41390 repo: id: 526 url: https://api.github.com/repos/github/hello-world name: hello-world base: ref: master sha: e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f repo: id: 526 url: https://api.github.com/repos/github/hello-world name: hello-world responses: not_found: description: Resource not found content: application/json: schema: $ref: '#/components/schemas/basic-error' internal_error: description: Internal Error content: application/json: schema: $ref: '#/components/schemas/basic-error' conflict: description: Conflict content: application/json: schema: $ref: '#/components/schemas/basic-error' forbidden: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/basic-error' parameters: check-suite-id: name: check_suite_id description: The unique identifier of the check suite. in: path required: true schema: type: integer workflow-run-branch: name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. in: query required: false schema: type: string check-name: name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string workflow-run-check-suite-id: name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer workflow-id: name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name as a string. required: true schema: oneOf: - type: integer - type: string owner: name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string artifact-name: name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. in: query required: false schema: type: string check-run-id: name: check_run_id description: The unique identifier of the check run. in: path required: true schema: type: integer workflow-run-status: name: status description: Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. in: query required: false schema: type: string enum: - completed - action_required - cancelled - failure - neutral - skipped - stale - success - timed_out - in_progress - queued - requested - waiting - pending job-id: name: job_id description: The unique identifier of the job. in: path required: true schema: type: integer event: name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/enterprise-server@3.9/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." in: query required: false schema: type: string workflow-run-head-sha: name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. in: query required: false schema: type: string actor: name: actor description: Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. in: query 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 created: name: created description: Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/enterprise-server@3.9/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." in: query required: false schema: type: string format: date-time status: name: status description: Returns check runs with the specified `status`. in: query required: false schema: type: string enum: - queued - in_progress - completed 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 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 exclude-pull-requests: name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). in: query required: false schema: type: boolean default: false commit-ref: name: ref description: The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. in: path required: true schema: type: string x-multi-segment: true attempt-number: name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer run-id: name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer 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