> ## Documentation Index
> Fetch the complete documentation index at: https://docs.automate.ax/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Automate.ax automations are TypeScript programs.
> Use Bun for installation and command examples.
> Use Automate.ax for the product name and automate.ax for the package, CLI, and domain.
> Treat documented public APIs as current; do not invent transitional or deprecated names.

# On GitHub check suite event

> Start an automation from GitHub check suite activity.

`github.onCheckSuiteEvent` starts an automation for any delivered `check_suite` action.

```ts automations/watch-github-check-suites.automation.ts theme={null}
import { automation } from "automate.ax"
import { github } from "automate.ax/github"

export default automation("Watch GitHub check suites", () => {
  const event = github.onCheckSuiteEvent()
  github.getCombinedCommitStatus({
    owner: event.repository.owner.login,
    repository: event.repository.name,
    ref: event.check_suite.head_sha,
  })
})
```

Returns GitHub's typed check-suite webhook payload. Apps with Checks read permission receive completed suites; requested and rerequested actions require Checks write permission and remain available through the broad type if the installation later grants it. Requires Checks read permission.