Dispatch GitHub repository event

github.dispatchRepositoryEvent sends a custom repository_dispatch event to a repository.

automations/dispatch-github-deploy.automation.ts

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

export default automation("Dispatch GitHub deployment", () => {
  github.dispatchRepositoryEvent({
    clientPayload: { environment: "production", releaseId: "rel_123" },
    eventType: "deploy.requested",
    owner: "SentsCo",
    repository: "automate.ax",
  })
})

Provide owner, repository, and an eventType of at most 100 characters. Optional clientPayload must be JSON-compatible, may have at most 10 top-level properties, and its JSON representation must be smaller than 64 KB. The action completes after GitHub accepts the event and returns {}. GitHub delivers the value as action to app webhooks and evaluates matching repository_dispatch workflow triggers on the default branch. Requires Contents write permission.

Built-in triggers

Built-in actions

Runtime utilities

Integrations

Dispatch GitHub repository event