On GitHub pull request event

onGitHubPullRequestEvent exposes the broad GitHub pull_request webhook family. Use it for actions not covered by a semantic trigger.

automations/watch-github-pull-requests.automation.ts

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

export default automation("Watch GitHub pull requests", () => {
  const event = onGitHubPullRequestEvent()
  event.transform(({ action, pull_request, repository }) => ({
    action,
    pullRequest: pull_request.number,
    repository: repository.full_name,
  }))
})

Optional static account defaults to the project binding. Returns Signal<GitHubPullRequestEvent>, GitHub’s typed pull request webhook union with action, pull_request, repository, sender, installation, and action-specific fields. The installation needs Pull requests read permission and repository access.

⌘I

Get started

Concepts

Reference

On GitHub pull request event