Check Suite
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.
Actions
| Action | Sent when |
|---|---|
completed | All check runs in a check suite have completed, and a conclusion is available. |
requested | Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see the GraphQL API documentation for creating a check run or "Create a check run" in the REST API documentation. |
rerequested | Someone requested to re-run the check runs in a check suite. For more information, see the GraphQL API documentation for creating a check suite or "Create a check suite" in the REST API documentation. |
Payload
Fields of the delivery for the first action above. Every action shares the event's core fields.
| Field | Type | Required | Description |
|---|---|---|---|
action | string | Yes | |
check_suite | object | Yes | The check_suite. |
enterprise | object | No | An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured |
installation | object | No | The GitHub App installation. Webhook payloads contain the installation property when the event 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" 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.