Run query

convex.runQuery calls a named query on a connected Convex deployment and returns its Convex value.

automations/read-convex-messages.automation.ts

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

export default automation("Read Convex messages", () => {
  onSchedule({ schedule: "0 * * * *" })
  convex.runQuery({
    functionName: "messages:list",
    arguments: { limit: 25 },
  })
})

Inputs

Input	Type	Required	Default	Description
`functionName`	`string`	Yes	None	Exported HTTP API path, such as `messages:list` or `reports:get`.
`arguments`	`Record<string, ConvexValue>`	No	`{}`	Convex function arguments.
`deployment`	`string`	No	`prod`	Deployment reference for a project OAuth connection. Omit it for a deployment-key connection.
Second argument: `{ account }`	`string \| IntegrationAccountReference<"convex">`	No	Project default	Connected Convex account.

The result is a ConvexValue, including Convex bigint and ArrayBuffer values. For an internal query, omit the internal. prefix used by generated Convex references and connect credentials with the corresponding run-internal permission. The selected deployment must use a hosted .convex.cloud URL. Automate.ax can’t reach a local development deployment.

Built-in triggers

Built-in actions

Runtime utilities

Integrations

Inputs

​Inputs

Inputs