This page was generated based on Github’s Documentation. See our welcome page for context and details.
Github Event check_run
#
Github Action Trigger #
Webhook event payload | Activity types | GITHUB_SHA | GITHUB_REF |
---|---|---|---|
check_run | - created - rerequested - completed - requested_action | Last commit on default branch | Default branch |
Note: More than one activity type triggers this event. For information about each activity type, see “Webhook events and payloads.” By default, all activity types trigger workflows that run on this event. You can limit your workflow runs to specific activity types using the types
keyword. For more information, see “Workflow syntax for GitHub Actions.”
Note: This event will only trigger a workflow run if the workflow file is on the default branch.
Runs your workflow when activity related to a check run occurs. A check run is an individual test that is part of a check suite. For information, see “Using the REST API to interact with checks.” For information about the check run APIs, see “Objects” in the GraphQL API documentation or “REST API endpoints for checks.”
For example, you can run a workflow when a check run has been rerequested
or completed
.
on:
check_run:
types: [rerequested, completed]
Event Payload #
Activities: completed
, created
, requested_action
, rerequested
Common Fields #
These fields are common to every event types available with this trigger.
field | type | required | description |
---|---|---|---|
github.event.check_run | object | required | A check performed on the code of a given code change |
github.event.check_run.app | object | required | 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. |
github.event.check_run.app.id | integer | required | Unique identifier of the GitHub app |
github.event.check_run.app.slug | string | optional | The slug name of the GitHub app |
github.event.check_run.app.node_id | string | required | |
github.event.check_run.app.owner | object | required | A GitHub user. |
github.event.check_run.app.owner.name | string or null | optional | |
github.event.check_run.app.owner.email | string or null | optional | |
github.event.check_run.app.owner.login | string | required | |
github.event.check_run.app.owner.id | integer | required | |
github.event.check_run.app.owner.node_id | string | required | |
github.event.check_run.app.owner.avatar_url | string | required | |
github.event.check_run.app.owner.gravatar_id | string or null | required | |
github.event.check_run.app.owner.url | string | required | |
github.event.check_run.app.owner.html_url | string | required | |
github.event.check_run.app.owner.followers_url | string | required | |
github.event.check_run.app.owner.following_url | string | required | |
github.event.check_run.app.owner.gists_url | string | required | |
github.event.check_run.app.owner.starred_url | string | required | |
github.event.check_run.app.owner.subscriptions_url | string | required | |
github.event.check_run.app.owner.organizations_url | string | required | |
github.event.check_run.app.owner.repos_url | string | required | |
github.event.check_run.app.owner.events_url | string | required | |
github.event.check_run.app.owner.received_events_url | string | required | |
github.event.check_run.app.owner.type | string | required | |
github.event.check_run.app.owner.site_admin | boolean | required | |
github.event.check_run.app.owner.starred_at | string | optional | |
github.event.check_run.app.name | string | required | The name of the GitHub app |
github.event.check_run.app.description | string or null | required | |
github.event.check_run.app.external_url | string | required | |
github.event.check_run.app.html_url | string | required | |
github.event.check_run.app.created_at | string | required | |
github.event.check_run.app.updated_at | string | required | |
github.event.check_run.app.permissions | object | required | The set of permissions for the GitHub app |
github.event.check_run.app.permissions.issues | string | optional | |
github.event.check_run.app.permissions.checks | string | optional | |
github.event.check_run.app.permissions.metadata | string | optional | |
github.event.check_run.app.permissions.contents | string | optional | |
github.event.check_run.app.permissions.deployments | string | optional | |
github.event.check_run.app.events | array of strings | required | The list of events for the GitHub app |
github.event.check_run.app.installations_count | integer | optional | The number of installations associated with the GitHub app |
github.event.check_run.app.client_id | string | optional | |
github.event.check_run.app.client_secret | string | optional | |
github.event.check_run.app.webhook_secret | string or null | optional | |
github.event.check_run.app.pem | string | optional | |
github.event.check_run.check_suite | object | required | A suite of checks performed on the code of a given code change |
github.event.check_run.check_suite.after | string or null | optional | |
github.event.check_run.check_suite.app | object | optional | 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. |
github.event.check_run.check_suite.app.id | integer | required | Unique identifier of the GitHub app |
github.event.check_run.check_suite.app.slug | string | optional | The slug name of the GitHub app |
github.event.check_run.check_suite.app.node_id | string | required | |
github.event.check_run.check_suite.app.owner | object | required | A GitHub user. |
github.event.check_run.check_suite.app.owner.name | string or null | optional | |
github.event.check_run.check_suite.app.owner.email | string or null | optional | |
github.event.check_run.check_suite.app.owner.login | string | required | |
github.event.check_run.check_suite.app.owner.id | integer | required | |
github.event.check_run.check_suite.app.owner.node_id | string | required | |
github.event.check_run.check_suite.app.owner.avatar_url | string | required | |
github.event.check_run.check_suite.app.owner.gravatar_id | string or null | required | |
github.event.check_run.check_suite.app.owner.url | string | required | |
github.event.check_run.check_suite.app.owner.html_url | string | required | |
github.event.check_run.check_suite.app.owner.followers_url | string | required | |
github.event.check_run.check_suite.app.owner.following_url | string | required | |
github.event.check_run.check_suite.app.owner.gists_url | string | required | |
github.event.check_run.check_suite.app.owner.starred_url | string | required | |
github.event.check_run.check_suite.app.owner.subscriptions_url | string | required | |
github.event.check_run.check_suite.app.owner.organizations_url | string | required | |
github.event.check_run.check_suite.app.owner.repos_url | string | required | |
github.event.check_run.check_suite.app.owner.events_url | string | required | |
github.event.check_run.check_suite.app.owner.received_events_url | string | required | |
github.event.check_run.check_suite.app.owner.type | string | required | |
github.event.check_run.check_suite.app.owner.site_admin | boolean | required | |
github.event.check_run.check_suite.app.owner.starred_at | string | optional | |
github.event.check_run.check_suite.app.name | string | required | The name of the GitHub app |
github.event.check_run.check_suite.app.description | string or null | required | |
github.event.check_run.check_suite.app.external_url | string | required | |
github.event.check_run.check_suite.app.html_url | string | required | |
github.event.check_run.check_suite.app.created_at | string | required | |
github.event.check_run.check_suite.app.updated_at | string | required | |
github.event.check_run.check_suite.app.permissions | object | required | The set of permissions for the GitHub app |
github.event.check_run.check_suite.app.permissions.issues | string | optional | |
github.event.check_run.check_suite.app.permissions.checks | string | optional | |
github.event.check_run.check_suite.app.permissions.metadata | string | optional | |
github.event.check_run.check_suite.app.permissions.contents | string | optional | |
github.event.check_run.check_suite.app.permissions.deployments | string | optional | |
github.event.check_run.check_suite.app.events | array of strings | required | The list of events for the GitHub app |
github.event.check_run.check_suite.app.installations_count | integer | optional | The number of installations associated with the GitHub app |
github.event.check_run.check_suite.app.client_id | string | optional | |
github.event.check_run.check_suite.app.client_secret | string | optional | |
github.event.check_run.check_suite.app.webhook_secret | string or null | optional | |
github.event.check_run.check_suite.app.pem | string | optional | |
github.event.check_run.check_suite.before | string or null | optional | |
github.event.check_run.check_suite.conclusion | success , failure , neutral , cancelled , skipped , timed_out , action_required , stale , startup_failure , None | optional | |
github.event.check_run.check_suite.created_at | string | optional | |
github.event.check_run.check_suite.head_branch | string or null | optional | |
github.event.check_run.check_suite.head_sha | string | optional | The SHA of the head commit that is being checked. |
github.event.check_run.check_suite.id | integer | optional | |
github.event.check_run.check_suite.node_id | string | optional | |
github.event.check_run.check_suite.pull_requests | array of objects | optional | |
github.event.check_run.check_suite.pull_requests.id | integer | required | |
github.event.check_run.check_suite.pull_requests.number | integer | required | |
github.event.check_run.check_suite.pull_requests.url | string | required | |
github.event.check_run.check_suite.pull_requests.head | object | required | |
github.event.check_run.check_suite.pull_requests.head.ref | string | required | |
github.event.check_run.check_suite.pull_requests.head.sha | string | required | |
github.event.check_run.check_suite.pull_requests.head.repo | object | required | |
github.event.check_run.check_suite.pull_requests.head.repo.id | integer | required | |
github.event.check_run.check_suite.pull_requests.head.repo.url | string | required | |
github.event.check_run.check_suite.pull_requests.head.repo.name | string | required | |
github.event.check_run.check_suite.pull_requests.base | object | required | |
github.event.check_run.check_suite.pull_requests.base.ref | string | required | |
github.event.check_run.check_suite.pull_requests.base.sha | string | required | |
github.event.check_run.check_suite.pull_requests.base.repo | object | required | |
github.event.check_run.check_suite.pull_requests.base.repo.id | integer | required | |
github.event.check_run.check_suite.pull_requests.base.repo.url | string | required | |
github.event.check_run.check_suite.pull_requests.base.repo.name | string | required | |
github.event.check_run.check_suite.repository | object | optional | Minimal Repository |
github.event.check_run.check_suite.repository.id | integer | required | |
github.event.check_run.check_suite.repository.node_id | string | required | |
github.event.check_run.check_suite.repository.name | string | required | |
github.event.check_run.check_suite.repository.full_name | string | required | |
github.event.check_run.check_suite.repository.owner | object | required | A GitHub user. |
github.event.check_run.check_suite.repository.owner.name | string or null | optional | |
github.event.check_run.check_suite.repository.owner.email | string or null | optional | |
github.event.check_run.check_suite.repository.owner.login | string | required | |
github.event.check_run.check_suite.repository.owner.id | integer | required | |
github.event.check_run.check_suite.repository.owner.node_id | string | required | |
github.event.check_run.check_suite.repository.owner.avatar_url | string | required | |
github.event.check_run.check_suite.repository.owner.gravatar_id | string or null | required | |
github.event.check_run.check_suite.repository.owner.url | string | required | |
github.event.check_run.check_suite.repository.owner.html_url | string | required | |
github.event.check_run.check_suite.repository.owner.followers_url | string | required | |
github.event.check_run.check_suite.repository.owner.following_url | string | required | |
github.event.check_run.check_suite.repository.owner.gists_url | string | required | |
github.event.check_run.check_suite.repository.owner.starred_url | string | required | |
github.event.check_run.check_suite.repository.owner.subscriptions_url | string | required | |
github.event.check_run.check_suite.repository.owner.organizations_url | string | required | |
github.event.check_run.check_suite.repository.owner.repos_url | string | required | |
github.event.check_run.check_suite.repository.owner.events_url | string | required | |
github.event.check_run.check_suite.repository.owner.received_events_url | string | required | |
github.event.check_run.check_suite.repository.owner.type | string | required | |
github.event.check_run.check_suite.repository.owner.site_admin | boolean | required | |
github.event.check_run.check_suite.repository.owner.starred_at | string | optional | |
github.event.check_run.check_suite.repository.private | boolean | required | |
github.event.check_run.check_suite.repository.html_url | string | required | |
github.event.check_run.check_suite.repository.description | string or null | required | |
github.event.check_run.check_suite.repository.fork | boolean | required | |
github.event.check_run.check_suite.repository.url | string | required | |
github.event.check_run.check_suite.repository.archive_url | string | required | |
github.event.check_run.check_suite.repository.assignees_url | string | required | |
github.event.check_run.check_suite.repository.blobs_url | string | required | |
github.event.check_run.check_suite.repository.branches_url | string | required | |
github.event.check_run.check_suite.repository.collaborators_url | string | required | |
github.event.check_run.check_suite.repository.comments_url | string | required | |
github.event.check_run.check_suite.repository.commits_url | string | required | |
github.event.check_run.check_suite.repository.compare_url | string | required | |
github.event.check_run.check_suite.repository.contents_url | string | required | |
github.event.check_run.check_suite.repository.contributors_url | string | required | |
github.event.check_run.check_suite.repository.deployments_url | string | required | |
github.event.check_run.check_suite.repository.downloads_url | string | required | |
github.event.check_run.check_suite.repository.events_url | string | required | |
github.event.check_run.check_suite.repository.forks_url | string | required | |
github.event.check_run.check_suite.repository.git_commits_url | string | required | |
github.event.check_run.check_suite.repository.git_refs_url | string | required | |
github.event.check_run.check_suite.repository.git_tags_url | string | required | |
github.event.check_run.check_suite.repository.git_url | string | optional | |
github.event.check_run.check_suite.repository.issue_comment_url | string | required | |
github.event.check_run.check_suite.repository.issue_events_url | string | required | |
github.event.check_run.check_suite.repository.issues_url | string | required | |
github.event.check_run.check_suite.repository.keys_url | string | required | |
github.event.check_run.check_suite.repository.labels_url | string | required | |
github.event.check_run.check_suite.repository.languages_url | string | required | |
github.event.check_run.check_suite.repository.merges_url | string | required | |
github.event.check_run.check_suite.repository.milestones_url | string | required | |
github.event.check_run.check_suite.repository.notifications_url | string | required | |
github.event.check_run.check_suite.repository.pulls_url | string | required | |
github.event.check_run.check_suite.repository.releases_url | string | required | |
github.event.check_run.check_suite.repository.ssh_url | string | optional | |
github.event.check_run.check_suite.repository.stargazers_url | string | required | |
github.event.check_run.check_suite.repository.statuses_url | string | required | |
github.event.check_run.check_suite.repository.subscribers_url | string | required | |
github.event.check_run.check_suite.repository.subscription_url | string | required | |
github.event.check_run.check_suite.repository.tags_url | string | required | |
github.event.check_run.check_suite.repository.teams_url | string | required | |
github.event.check_run.check_suite.repository.trees_url | string | required | |
github.event.check_run.check_suite.repository.clone_url | string | optional | |
github.event.check_run.check_suite.repository.mirror_url | string or null | optional | |
github.event.check_run.check_suite.repository.hooks_url | string | required | |
github.event.check_run.check_suite.repository.svn_url | string | optional | |
github.event.check_run.check_suite.repository.homepage | string or null | optional | |
github.event.check_run.check_suite.repository.language | string or null | optional | |
github.event.check_run.check_suite.repository.forks_count | integer | optional | |
github.event.check_run.check_suite.repository.stargazers_count | integer | optional | |
github.event.check_run.check_suite.repository.watchers_count | integer | optional | |
github.event.check_run.check_suite.repository.size | integer | optional | The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. |
github.event.check_run.check_suite.repository.default_branch | string | optional | |
github.event.check_run.check_suite.repository.open_issues_count | integer | optional | |
github.event.check_run.check_suite.repository.is_template | boolean | optional | |
github.event.check_run.check_suite.repository.topics | array of strings | optional | |
github.event.check_run.check_suite.repository.has_issues | boolean | optional | |
github.event.check_run.check_suite.repository.has_projects | boolean | optional | |
github.event.check_run.check_suite.repository.has_wiki | boolean | optional | |
github.event.check_run.check_suite.repository.has_pages | boolean | optional | |
github.event.check_run.check_suite.repository.has_downloads | boolean | optional | |
github.event.check_run.check_suite.repository.has_discussions | boolean | optional | |
github.event.check_run.check_suite.repository.archived | boolean | optional | |
github.event.check_run.check_suite.repository.disabled | boolean | optional | |
github.event.check_run.check_suite.repository.visibility | string | optional | |
github.event.check_run.check_suite.repository.pushed_at | string or null | optional | |
github.event.check_run.check_suite.repository.created_at | string or null | optional | |
github.event.check_run.check_suite.repository.updated_at | string or null | optional | |
github.event.check_run.check_suite.repository.permissions | object | optional | |
github.event.check_run.check_suite.repository.permissions.admin | boolean | optional | |
github.event.check_run.check_suite.repository.permissions.maintain | boolean | optional | |
github.event.check_run.check_suite.repository.permissions.push | boolean | optional | |
github.event.check_run.check_suite.repository.permissions.triage | boolean | optional | |
github.event.check_run.check_suite.repository.permissions.pull | boolean | optional | |
github.event.check_run.check_suite.repository.role_name | string | optional | |
github.event.check_run.check_suite.repository.temp_clone_token | string | optional | |
github.event.check_run.check_suite.repository.delete_branch_on_merge | boolean | optional | |
github.event.check_run.check_suite.repository.subscribers_count | integer | optional | |
github.event.check_run.check_suite.repository.network_count | integer | optional | |
github.event.check_run.check_suite.repository.code_of_conduct | object | optional | Code Of Conduct |
github.event.check_run.check_suite.repository.code_of_conduct.key | string | required | |
github.event.check_run.check_suite.repository.code_of_conduct.name | string | required | |
github.event.check_run.check_suite.repository.code_of_conduct.url | string | required | |
github.event.check_run.check_suite.repository.code_of_conduct.body | string | optional | |
github.event.check_run.check_suite.repository.code_of_conduct.html_url | string or null | required | |
github.event.check_run.check_suite.repository.license | object or null | optional | |
github.event.check_run.check_suite.repository.license.key | string | optional | |
github.event.check_run.check_suite.repository.license.name | string | optional | |
github.event.check_run.check_suite.repository.license.spdx_id | string | optional | |
github.event.check_run.check_suite.repository.license.url | string | optional | |
github.event.check_run.check_suite.repository.license.node_id | string | optional | |
github.event.check_run.check_suite.repository.forks | integer | optional | |
github.event.check_run.check_suite.repository.open_issues | integer | optional | |
github.event.check_run.check_suite.repository.watchers | integer | optional | |
github.event.check_run.check_suite.repository.allow_forking | boolean | optional | |
github.event.check_run.check_suite.repository.web_commit_signoff_required | boolean | optional | |
github.event.check_run.check_suite.repository.security_and_analysis | object or null | optional | |
github.event.check_run.check_suite.repository.security_and_analysis.advanced_security | object | optional | |
github.event.check_run.check_suite.repository.security_and_analysis.advanced_security.status | enabled , disabled | optional | |
github.event.check_run.check_suite.repository.security_and_analysis.dependabot_security_updates | object | optional | Enable or disable Dependabot security updates for the repository. |
github.event.check_run.check_suite.repository.security_and_analysis.dependabot_security_updates.status | enabled , disabled | optional | The enablement status of Dependabot security updates for the repository. |
github.event.check_run.check_suite.repository.security_and_analysis.secret_scanning | object | optional | |
github.event.check_run.check_suite.repository.security_and_analysis.secret_scanning.status | enabled , disabled | optional | |
github.event.check_run.check_suite.repository.security_and_analysis.secret_scanning_push_protection | object | optional | |
github.event.check_run.check_suite.repository.security_and_analysis.secret_scanning_push_protection.status | enabled , disabled | optional | |
github.event.check_run.check_suite.status | queued , in_progress , completed , pending , waiting | optional | |
github.event.check_run.check_suite.updated_at | string | optional | |
github.event.check_run.check_suite.url | string | optional | |
github.event.check_run.completed_at | string or null | required | |
github.event.check_run.conclusion | waiting , pending , startup_failure , stale , success , failure , neutral , cancelled , skipped , timed_out , action_required , None | required | |
github.event.check_run.deployment | object | optional | A deployment created as the result of an Actions check run from a workflow that references an environment |
github.event.check_run.deployment.url | string | required | |
github.event.check_run.deployment.id | integer | required | Unique identifier of the deployment |
github.event.check_run.deployment.node_id | string | required | |
github.event.check_run.deployment.task | string | required | Parameter to specify a task to execute |
github.event.check_run.deployment.original_environment | string | optional | |
github.event.check_run.deployment.environment | string | required | Name for the target deployment environment. |
github.event.check_run.deployment.description | string or null | required | |
github.event.check_run.deployment.created_at | string | required | |
github.event.check_run.deployment.updated_at | string | required | |
github.event.check_run.deployment.statuses_url | string | required | |
github.event.check_run.deployment.repository_url | string | required | |
github.event.check_run.deployment.transient_environment | boolean | optional | Specifies if the given environment is will no longer exist at some point in the future. Default: false. |
github.event.check_run.deployment.production_environment | boolean | optional | Specifies if the given environment is one that end-users directly interact with. Default: false. |
github.event.check_run.deployment.performed_via_github_app | object | optional | 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. |
github.event.check_run.deployment.performed_via_github_app.id | integer | required | Unique identifier of the GitHub app |
github.event.check_run.deployment.performed_via_github_app.slug | string | optional | The slug name of the GitHub app |
github.event.check_run.deployment.performed_via_github_app.node_id | string | required | |
github.event.check_run.deployment.performed_via_github_app.owner | object | required | A GitHub user. |
github.event.check_run.deployment.performed_via_github_app.owner.name | string or null | optional | |
github.event.check_run.deployment.performed_via_github_app.owner.email | string or null | optional | |
github.event.check_run.deployment.performed_via_github_app.owner.login | string | required | |
github.event.check_run.deployment.performed_via_github_app.owner.id | integer | required | |
github.event.check_run.deployment.performed_via_github_app.owner.node_id | string | required | |
github.event.check_run.deployment.performed_via_github_app.owner.avatar_url | string | required | |
github.event.check_run.deployment.performed_via_github_app.owner.gravatar_id | string or null | required | |
github.event.check_run.deployment.performed_via_github_app.owner.url | string | required | |
github.event.check_run.deployment.performed_via_github_app.owner.html_url | string | required | |
github.event.check_run.deployment.performed_via_github_app.owner.followers_url | string | required | |
github.event.check_run.deployment.performed_via_github_app.owner.following_url | string | required | |
github.event.check_run.deployment.performed_via_github_app.owner.gists_url | string | required | |
github.event.check_run.deployment.performed_via_github_app.owner.starred_url | string | required | |
github.event.check_run.deployment.performed_via_github_app.owner.subscriptions_url | string | required | |
github.event.check_run.deployment.performed_via_github_app.owner.organizations_url | string | required | |
github.event.check_run.deployment.performed_via_github_app.owner.repos_url | string | required | |
github.event.check_run.deployment.performed_via_github_app.owner.events_url | string | required | |
github.event.check_run.deployment.performed_via_github_app.owner.received_events_url | string | required | |
github.event.check_run.deployment.performed_via_github_app.owner.type | string | required | |
github.event.check_run.deployment.performed_via_github_app.owner.site_admin | boolean | required | |
github.event.check_run.deployment.performed_via_github_app.owner.starred_at | string | optional | |
github.event.check_run.deployment.performed_via_github_app.name | string | required | The name of the GitHub app |
github.event.check_run.deployment.performed_via_github_app.description | string or null | required | |
github.event.check_run.deployment.performed_via_github_app.external_url | string | required | |
github.event.check_run.deployment.performed_via_github_app.html_url | string | required | |
github.event.check_run.deployment.performed_via_github_app.created_at | string | required | |
github.event.check_run.deployment.performed_via_github_app.updated_at | string | required | |
github.event.check_run.deployment.performed_via_github_app.permissions | object | required | The set of permissions for the GitHub app |
github.event.check_run.deployment.performed_via_github_app.permissions.issues | string | optional | |
github.event.check_run.deployment.performed_via_github_app.permissions.checks | string | optional | |
github.event.check_run.deployment.performed_via_github_app.permissions.metadata | string | optional | |
github.event.check_run.deployment.performed_via_github_app.permissions.contents | string | optional | |
github.event.check_run.deployment.performed_via_github_app.permissions.deployments | string | optional | |
github.event.check_run.deployment.performed_via_github_app.events | array of strings | required | The list of events for the GitHub app |
github.event.check_run.deployment.performed_via_github_app.installations_count | integer | optional | The number of installations associated with the GitHub app |
github.event.check_run.deployment.performed_via_github_app.client_id | string | optional | |
github.event.check_run.deployment.performed_via_github_app.client_secret | string | optional | |
github.event.check_run.deployment.performed_via_github_app.webhook_secret | string or null | optional | |
github.event.check_run.deployment.performed_via_github_app.pem | string | optional | |
github.event.check_run.details_url | string | required | |
github.event.check_run.external_id | string | required | |
github.event.check_run.head_sha | string | required | The SHA of the commit that is being checked. |
github.event.check_run.html_url | string | required | |
github.event.check_run.id | integer | required | The id of the check. |
github.event.check_run.name | string | required | The name of the check. |
github.event.check_run.node_id | string | required | |
github.event.check_run.output | object | required | |
github.event.check_run.output.annotations_count | integer | required | |
github.event.check_run.output.annotations_url | string | required | |
github.event.check_run.output.summary | string or null | required | |
github.event.check_run.output.text | string or null | required | |
github.event.check_run.output.title | string or null | required | |
github.event.check_run.pull_requests | array of objects | required | |
github.event.check_run.pull_requests.id | integer | required | |
github.event.check_run.pull_requests.number | integer | required | |
github.event.check_run.pull_requests.url | string | required | |
github.event.check_run.pull_requests.head | object | required | |
github.event.check_run.pull_requests.head.ref | string | required | |
github.event.check_run.pull_requests.head.sha | string | required | |
github.event.check_run.pull_requests.head.repo | object | required | |
github.event.check_run.pull_requests.head.repo.id | integer | required | |
github.event.check_run.pull_requests.head.repo.url | string | required | |
github.event.check_run.pull_requests.head.repo.name | string | required | |
github.event.check_run.pull_requests.base | object | required | |
github.event.check_run.pull_requests.base.ref | string | required | |
github.event.check_run.pull_requests.base.sha | string | required | |
github.event.check_run.pull_requests.base.repo | object | required | |
github.event.check_run.pull_requests.base.repo.id | integer | required | |
github.event.check_run.pull_requests.base.repo.url | string | required | |
github.event.check_run.pull_requests.base.repo.name | string | required | |
github.event.check_run.started_at | string | required | |
github.event.check_run.status | queued , in_progress , completed , pending | required | The phase of the lifecycle that the check is currently in. |
github.event.check_run.url | string | required | |
github.event.installation | object | optional | The GitHub App installation. Webhook payloads contain the |
github.event.organization | object | optional | A GitHub organization. Webhook payloads contain the |
github.event.repository | object | required | The repository on GitHub where the event occurred. Webhook payloads contain the |
github.event.sender | object | required | The GitHub user that triggered the event. This property is included in every webhook payload. |
completed
#
This event occurs when there is activity relating to a check run. For information about check runs, see "Getting started with the Checks API." For information about the APIs to manage check runs, see the GraphQL API documentation or "Check 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
.
field | type | required | description |
---|---|---|---|
github.event.action | completed | optional |
created
#
This event occurs when there is activity relating to a check run. For information about check runs, see "Getting started with the Checks API." For information about the APIs to manage check runs, see the GraphQL API documentation or "Check 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
.
field | type | required | description |
---|---|---|---|
github.event.action | created | optional |
requested_action
#
This event occurs when there is activity relating to a check run. For information about check runs, see "Getting started with the Checks API." For information about the APIs to manage check runs, see the GraphQL API documentation or "Check 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
.
field | type | required | description |
---|---|---|---|
github.event.action | requested_action | required | |
github.event.requested_action | object | optional | The action requested by the user. |
github.event.requested_action.identifier | string | optional | The integrator reference of the action requested by the user. |
rerequested
#
This event occurs when there is activity relating to a check run. For information about check runs, see "Getting started with the Checks API." For information about the APIs to manage check runs, see the GraphQL API documentation or "Check 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
.
field | type | required | description |
---|---|---|---|
github.event.action | rerequested | optional |