On GitHub workflow run event

onGitHubWorkflowRunEvent exposes the broad GitHub workflow_run webhook family. Use a semantic trigger when you care about one lifecycle stage or conclusion.

automations/watch-github-workflows.automation.ts

import { automation } from "automate.ax"
import { onGitHubWorkflowRunEvent } from "automate.ax/github"

export default automation("Watch GitHub workflows", () => {
  const event = onGitHubWorkflowRunEvent()
  event.transform(({ action, workflow_run }) => ({
    action,
    conclusion: workflow_run.conclusion,
    runId: workflow_run.id,
  }))
})

Optional static account defaults to the project binding. Returns Signal<GitHubWorkflowRunEvent>, GitHub’s typed requested, in-progress, and completed webhook union. The installation needs Actions read permission and repository access. Workflow job events are a separate GitHub webhook family and do not emit this trigger.

⌘I

Get started

Concepts

Reference

On GitHub workflow run event