1
0
mirror of synced 2026-01-01 09:04:46 -05:00
Files
docs/data/reusables/webhooks/check_run_properties.md
2022-05-13 14:32:50 -04:00

2.5 KiB

Key Type Description
action string The action performed. Can be one of:
  • created - A new check run was created.
  • completed - The status of the check run is completed.
  • rerequested - Someone requested to re-run your check run from the pull request UI. See "About status checks" for more details about the GitHub UI. When you receive a rerequested action, you'll need to create a new check run. Only the {% data variables.product.prodname_github_app %} that someone requests to re-run the check will receive the rerequested payload.
  • requested_action - Someone requested an action your app provides to be taken. Only the {% data variables.product.prodname_github_app %} someone requests to perform an action will receive the requested_action payload. To learn more about check runs and requested actions, see "Check runs and requested actions."
check_run object The check_run.
check_run[status] string The current status of the check run. Can be queued, in_progress, or completed.
check_run[conclusion] string The result of the completed check run. Can be one of success, failure, neutral, cancelled, timed_out, action_required or stale. This value will be null until the check run has completed.
check_run[name] string The name of the check run.
check_run[check_suite][id] integer The id of the check suite that this check run is part of.
check_run[check_suite][pull_requests] array An array of pull requests that match this check suite. A pull request matches a check suite if they have the same head_branch.

Note:
  • The head_sha of the check suite can differ from the sha of the pull request if subsequent pushes are made into the PR.
  • When the check suite's head_branch is in a forked repository it will be null and the pull_requests array will be empty.
check_run[check_suite][deployment] object A deployment to a repository environment. This will only be populated if the check run was created by a {% data variables.product.prodname_actions %} workflow job that references an environment.
requested_action object The action requested by the user.
requested_action[identifier] string The integrator reference of the action requested by the user.