> ## 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 repository dispatch

> Run when a GitHub App sends a custom repository dispatch event.

`github.onRepositoryDispatch` handles custom events sent through GitHub's repository dispatch endpoint.

```ts automations/on-github-repository-dispatch.automation.ts theme={null}
import { automation } from "automate.ax"
import { github } from "automate.ax/github"

export default automation("GitHub repository dispatch", () => {
  const event = github.onRepositoryDispatch()
  // Sync the GitHub repository to the asset inventory.
})
```

Returns the custom `action` (the sender's `eventType`), `client_payload`, default `branch`, repository, sender, and installation. Event types are user-defined, so inspect `event.action` when one automation handles several. Requires Contents read permission.