On GitHub check suite event

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

automations/watch-github-check-suites.automation.ts

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.

Built-in triggers

Built-in actions

Runtime utilities

Integrations

On GitHub check suite event