This page was generated based on Github’s Documentation. See our welcome page for context and details.
Github Event check_suite
#
Github Action Trigger #
Webhook event payload | Activity types | GITHUB_SHA | GITHUB_REF |
---|---|---|---|
check_suite | - completed | 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.” Although only the completed
activity type is supported, specifying the activity type will keep your workflow specific if more activity types are added in the future. 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.
Note: To prevent recursive workflows, this event does not trigger workflows if the check suite was created by GitHub Actions.
Runs your workflow when check suite activity occurs. A check suite is a collection of the check runs created for a specific commit. Check suites summarize the status and conclusion of the check runs that are in the suite. For information, see “Using the REST API to interact with checks.” For information about the check suite APIs, see “Objects” in the GraphQL API documentation or “REST API endpoints for checks.”
For example, you can run a workflow when a check suite has been completed
.
on:
check_suite:
types: [completed]
Event Payload #
Activities: completed
, requested
, rerequested
Common Fields #
These fields are common to every event types available with this trigger.
field | type | required | description |
---|---|---|---|
github.event.check_suite | object | required | The check_suite. |
github.event.check_suite.after | string or null | required | |
github.event.check_suite.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_suite.app.created_at | string or null | required | |
github.event.check_suite.app.description | string or null | required | |
github.event.check_suite.app.events | array of strings | optional | The list of events for the GitHub app Supported values are: |
github.event.check_suite.app.external_url | string or null | required | |
github.event.check_suite.app.html_url | string | required | |
github.event.check_suite.app.id | integer or null | required | Unique identifier of the GitHub app |
github.event.check_suite.app.name | string | required | The name of the GitHub app |
github.event.check_suite.app.node_id | string | required | |
github.event.check_suite.app.owner | object or null | required | |
github.event.check_suite.app.owner.avatar_url | string | optional | |
github.event.check_suite.app.owner.deleted | boolean | optional | |
github.event.check_suite.app.owner.email | string or null | optional | |
github.event.check_suite.app.owner.events_url | string | optional | |
github.event.check_suite.app.owner.followers_url | string | optional | |
github.event.check_suite.app.owner.following_url | string | optional | |
github.event.check_suite.app.owner.gists_url | string | optional | |
github.event.check_suite.app.owner.gravatar_id | string | optional | |
github.event.check_suite.app.owner.html_url | string | optional | |
github.event.check_suite.app.owner.id | integer | required | |
github.event.check_suite.app.owner.login | string | required | |
github.event.check_suite.app.owner.name | string | optional | |
github.event.check_suite.app.owner.node_id | string | optional | |
github.event.check_suite.app.owner.organizations_url | string | optional | |
github.event.check_suite.app.owner.received_events_url | string | optional | |
github.event.check_suite.app.owner.repos_url | string | optional | |
github.event.check_suite.app.owner.site_admin | boolean | optional | |
github.event.check_suite.app.owner.starred_url | string | optional | |
github.event.check_suite.app.owner.subscriptions_url | string | optional | |
github.event.check_suite.app.owner.type | Bot , User , Organization | optional | |
github.event.check_suite.app.owner.url | string | optional | |
github.event.check_suite.app.permissions | object | optional | The set of permissions for the GitHub app |
github.event.check_suite.app.permissions.actions | read , write | optional | |
github.event.check_suite.app.permissions.administration | read , write | optional | |
github.event.check_suite.app.permissions.checks | read , write | optional | |
github.event.check_suite.app.permissions.content_references | read , write | optional | |
github.event.check_suite.app.permissions.contents | read , write | optional | |
github.event.check_suite.app.permissions.deployments | read , write | optional | |
github.event.check_suite.app.permissions.discussions | read , write | optional | |
github.event.check_suite.app.permissions.emails | read , write | optional | |
github.event.check_suite.app.permissions.environments | read , write | optional | |
github.event.check_suite.app.permissions.issues | read , write | optional | |
github.event.check_suite.app.permissions.keys | read , write | optional | |
github.event.check_suite.app.permissions.members | read , write | optional | |
github.event.check_suite.app.permissions.metadata | read , write | optional | |
github.event.check_suite.app.permissions.organization_administration | read , write | optional | |
github.event.check_suite.app.permissions.organization_hooks | read , write | optional | |
github.event.check_suite.app.permissions.organization_packages | read , write | optional | |
github.event.check_suite.app.permissions.organization_plan | read , write | optional | |
github.event.check_suite.app.permissions.organization_projects | read , write , admin | optional | |
github.event.check_suite.app.permissions.organization_secrets | read , write | optional | |
github.event.check_suite.app.permissions.organization_self_hosted_runners | read , write | optional | |
github.event.check_suite.app.permissions.organization_user_blocking | read , write | optional | |
github.event.check_suite.app.permissions.packages | read , write | optional | |
github.event.check_suite.app.permissions.pages | read , write | optional | |
github.event.check_suite.app.permissions.pull_requests | read , write | optional | |
github.event.check_suite.app.permissions.repository_hooks | read , write | optional | |
github.event.check_suite.app.permissions.repository_projects | read , write , admin | optional | |
github.event.check_suite.app.permissions.secret_scanning_alerts | read , write | optional | |
github.event.check_suite.app.permissions.secrets | read , write | optional | |
github.event.check_suite.app.permissions.security_events | read , write | optional | |
github.event.check_suite.app.permissions.security_scanning_alert | read , write | optional | |
github.event.check_suite.app.permissions.single_file | read , write | optional | |
github.event.check_suite.app.permissions.statuses | read , write | optional | |
github.event.check_suite.app.permissions.team_discussions | read , write | optional | |
github.event.check_suite.app.permissions.vulnerability_alerts | read , write | optional | |
github.event.check_suite.app.permissions.workflows | read , write | optional | |
github.event.check_suite.app.slug | string | optional | The slug name of the GitHub app |
github.event.check_suite.app.updated_at | string or null | required | |
github.event.check_suite.before | string or null | required | |
github.event.check_suite.check_runs_url | string | required | |
github.event.check_suite.created_at | string | required | |
github.event.check_suite.head_branch | string or null | required | The head branch name the changes are on. |
github.event.check_suite.head_commit | object | required | |
github.event.check_suite.head_commit.author | object | required | Metaproperties for Git author/committer information. |
github.event.check_suite.head_commit.author.date | string | optional | |
github.event.check_suite.head_commit.author.email | string or null | required | |
github.event.check_suite.head_commit.author.name | string | required | The git author’s name. |
github.event.check_suite.head_commit.author.username | string | optional | |
github.event.check_suite.head_commit.committer | object | required | Metaproperties for Git author/committer information. |
github.event.check_suite.head_commit.committer.date | string | optional | |
github.event.check_suite.head_commit.committer.email | string or null | required | |
github.event.check_suite.head_commit.committer.name | string | required | The git author’s name. |
github.event.check_suite.head_commit.committer.username | string | optional | |
github.event.check_suite.head_commit.id | string | required | |
github.event.check_suite.head_commit.message | string | required | |
github.event.check_suite.head_commit.timestamp | string | required | |
github.event.check_suite.head_commit.tree_id | string | required | |
github.event.check_suite.head_sha | string | required | The SHA of the head commit that is being checked. |
github.event.check_suite.id | integer | required | |
github.event.check_suite.latest_check_runs_count | integer | required | |
github.event.check_suite.node_id | string | required | |
github.event.check_suite.pull_requests | array of objects | required | An array of pull requests that match this check suite. A pull request matches a check suite if they have the same |
github.event.check_suite.pull_requests.base | object | required | |
github.event.check_suite.pull_requests.base.ref | string | required | |
github.event.check_suite.pull_requests.base.repo | object | required | |
github.event.check_suite.pull_requests.base.repo.id | integer | required | |
github.event.check_suite.pull_requests.base.repo.name | string | required | |
github.event.check_suite.pull_requests.base.repo.url | string | required | |
github.event.check_suite.pull_requests.base.sha | string | required | |
github.event.check_suite.pull_requests.head | object | required | |
github.event.check_suite.pull_requests.head.ref | string | required | |
github.event.check_suite.pull_requests.head.repo | object | required | |
github.event.check_suite.pull_requests.head.repo.id | integer | required | |
github.event.check_suite.pull_requests.head.repo.name | string | required | |
github.event.check_suite.pull_requests.head.repo.url | string | required | |
github.event.check_suite.pull_requests.head.sha | string | required | |
github.event.check_suite.pull_requests.id | integer | required | |
github.event.check_suite.pull_requests.number | integer | required | |
github.event.check_suite.pull_requests.url | string | required | |
github.event.check_suite.rerequestable | boolean | optional | |
github.event.check_suite.runs_rerequestable | boolean | optional | |
github.event.check_suite.updated_at | string | required | |
github.event.check_suite.url | string | required | URL that points to the check suite API resource. |
github.event.enterprise | object | optional | An enterprise on GitHub. Webhook payloads contain the |
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 suite. For information about check suites, see "Getting started with the Checks API." For information about the APIs to manage check suites, see the GraphQL API documentation or "Check 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
.
field | type | required | description |
---|---|---|---|
github.event.action | completed | required | |
github.event.check_suite.conclusion | success , failure , neutral , cancelled , timed_out , action_required , stale , None , skipped , startup_failure | required | The summary conclusion for all check runs that are part of the check suite. This value will be |
github.event.check_suite.status | requested , in_progress , completed , queued , None , pending | required | The summary status for all check runs that are part of the check suite. Can be |
requested
#
This event occurs when there is activity relating to a check suite. For information about check suites, see "Getting started with the Checks API." For information about the APIs to manage check suites, see the GraphQL API documentation or "Check 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
.
field | type | required | description |
---|---|---|---|
github.event.action | requested | required | |
github.event.check_suite.conclusion | success , failure , neutral , cancelled , timed_out , action_required , stale , None , skipped | required | The summary conclusion for all check runs that are part of the check suite. This value will be |
github.event.check_suite.status | requested , in_progress , completed , queued , None | required | The summary status for all check runs that are part of the check suite. Can be |
rerequested
#
This event occurs when there is activity relating to a check suite. For information about check suites, see "Getting started with the Checks API." For information about the APIs to manage check suites, see the GraphQL API documentation or "Check 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
.
field | type | required | description |
---|---|---|---|
github.event.action | rerequested | required | |
github.event.check_suite.conclusion | success , failure , neutral , cancelled , timed_out , action_required , stale , None | required | The summary conclusion for all check runs that are part of the check suite. This value will be |
github.event.check_suite.status | requested , in_progress , completed , queued , None | required | The summary status for all check runs that are part of the check suite. Can be |