On document event

convex.onDocumentEvent watches one table and emits created, updated, and deleted document changes.

automations/audit-convex-documents.automation.ts

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

export default automation("Audit Convex documents", () => {
  const event = convex.onDocumentEvent({ table: "messages" })
  // Route the Convex document event by action.
})

Options

Option	Type	Required	Default	Description
`table`	`string`	Yes	None	Convex table name.
`component`	`string`	No	`""`	Component path; the empty path selects the root component.
`deployment`	`string`	No	`prod`	Deployment reference for project OAuth.
`account`	`string \| IntegrationAccountReference<"convex">`	No	Project default	Connected Convex account.

Trigger data includes action, component, table, documentId, revision: bigint, and document. document is null for deletions. Automate.ax uses Convex Data Sync, which requires a Convex Pro deployment and deployment:data:view. It establishes the initial table baseline without firing events and resumes from a durable cursor. A Convex import or table replacement also re-establishes the baseline without producing a burst of false creates.

Built-in triggers

Built-in actions

Runtime utilities

Integrations

Options

​Options

Options