Checks

Note: The Checks API is currently in public beta and only available for use with GitHub Apps.

Send detailed information about the checks your integrations run with the Checks API. Rather than binary pass/fail build statuses, integrations can report rich statuses, annotate lines of code with detailed information, and kick off reruns. The Checks API functionality is available exclusively to your GitHub Apps.

Code with context


  • Produce sophisticated feedback so developers can understand the impact of their code
  • Leverage detailed information for CI, linting, and acceptance testing
  • Provide context for developers within pull requests in the new Checks tab

Integrations built with Checks API


Visual Studio App Center

Visual Studio App Center

Ship higher-quality iOS, Android, Windows, and macOS apps faster. Connect your repository, and within minutes, build in the cloud, test on real devices, distribute to beta testers and app stores, and view the results of checks right from GitHub.

Travis CI

Travis CI

Get a complete picture of a project’s health directly from GitHub by viewing your build’s stages, jobs, and results, including the config associated with them. You can also re-run builds from within the GitHub interface.

Circle CI

CircleCI (Coming Soon)

Speed up your test and development cycle without extra maintenance. Use CircleCI to track your GitHub project and quickly set up your first build with automatically generated build and test steps, and simple extensibility. Checks API compatibility with CircleCI is on the way.

Check runs API

The check runs API enables you to build GitHub Apps that run powerful checks against code changes in a repository. You can create apps that perform continuous integration, code linting, or code scanning services and provide detailed feedback on commits.

Check suites API

A check suite is a collection of the check runs created by a single GitHub App for a specific commit. Check suites summarize the status and conclusion of the check runs that a suite includes.

CheckRunEvent

This event is triggered when a check run is created, updated, requested, or rerequested.

CheckSuiteEvent

This event is triggered when code is pushed to a repository with a GitHub App installed.