1
0
mirror of synced 2026-01-06 06:02:35 -05:00
Files
docs/data/reusables/webhooks/check_suite_properties.md
Laura Coursen 8f964ea2cb GHEC version (#20947)
Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com>
Co-authored-by: Grace Park <gracepark@github.com>
Co-authored-by: Steve Guntrip <12534592+stevecat@users.noreply.github.com>
Co-authored-by: Robert Sese <sese@github.com>
Co-authored-by: Peter Bengtsson <peterbe@github.com>
Co-authored-by: Rachael Sewell <rachmari@github.com>
2021-10-15 15:41:33 -05:00

1.8 KiB

Key Type Description
action string The action performed. Can be:
  • completed - All check runs in a check suite have completed.
  • requested - Occurs when new code is pushed to the app's repository. When you receive the requested action events, you'll need to create a new check run.
  • rerequested - Occurs when someone requests to re-run the entire check suite from the pull request UI. When you receive the rerequested action events, you'll need to create a new check run. See "About status checks" for more details about the GitHub UI.
check_suite object The check_suite.
check_suite[head_branch] string The head branch name the changes are on.
check_suite[head_sha] string The SHA of the most recent commit for this check suite.
check_suite[status] string The summary status for all check runs that are part of the check suite. Can be requested, in_progress, or completed.
check_suite[conclusion] string The summary conclusion for all check runs that are part of the check suite. Can be one of success, failure, neutral, cancelled, timed_out, {% ifversion fpt or ghes or ghae or ghec %}action_required or stale{% else %}or action_required{% endif %}. This value will be null until the check run has completed.
check_suite[url] string URL that points to the check suite API resource.
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_sha and head_branch. When the check suite's head_branch is in a forked repository it will be null and the pull_requests array will be empty.