Check Run
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.
Actions
| Action | Sent when |
|---|---|
completed | A check run was completed, and a conclusion is available. |
created | A new check run was created. |
requested-action | A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the requested_action payload. For more information, see "Creating CI tests with the Checks API." |
rerequested | Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the rerequested payload. |
Payload
Fields of the delivery for the first action above. Every action shares the event's core fields.
| Field | Type | Required | Description |
|---|---|---|---|
action | string | No | |
check_run | object | Yes | A check performed on the code of a given code change |
installation | object | No | The GitHub App installation. Webhook payloads contain the installation property when the event is configured |
enterprise | object | No | An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured |
organization | object | No | A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an |
repository | object | Yes | The repository on GitHub where the event occurred. Webhook payloads contain the repository property |
sender | object | Yes | A GitHub user. |
Subscribing
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.