> ## 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 Vercel deployment event

> Start an automation from Vercel deployment lifecycle events.

`onVercelDeploymentEvent` is the broad deployment webhook trigger. It emits creation, readiness, success, error, cancellation, and promotion events for the connected Vercel installation. Prefer a specific deployment trigger when the automation handles one lifecycle event.

```ts automations/watch-vercel-deployments.automation.ts theme={null}
import { automation } from "automate.ax"
import { onVercelDeploymentEvent } from "automate.ax/vercel"

export default automation("Watch Vercel deployments", () => {
  const event = onVercelDeploymentEvent()
  event.transform(({ payload, type }) => ({
    deploymentId: payload.deployment.id,
    projectId: payload.project.id,
    type,
    url: payload.deployment.url,
  }))
})
```

Optional static `account` defaults to the project's Vercel binding and must use OAuth. Access-token connections cannot receive installation webhooks.

## Trigger data

The event `type` is `deployment.created`, `deployment.ready`, `deployment.succeeded`, `deployment.error`, `deployment.canceled`, or `deployment.promoted`. The payload includes the deployment, its project, the owning team or user, and provider fields supplied by Vercel. The top-level envelope includes `id`, `createdAt`, and `region`.