On invocation

onInvocation<T>() starts an automation with an encodable payload supplied by another automation. Name the entrypoint when the automation accepts different kinds of invocation. T is compile-time only; the platform does not apply a runtime payload schema.

automations/process-order.automation.ts

import { automation, onInvocation } from "automate.ax"

interface OrderInvocation {
  orderId: string
}

export default automation("Process order", () => {
  const invocation = onInvocation<OrderInvocation>("process-order")

  // Use invocation.orderId in actions.
})

Invoke it from another automation with the durable invokeAutomation action:

invokeAutomation<OrderInvocation>({
  automation: "Process order",
  entrypoint: "process-order",
  payload: { orderId: "order_123" },
  runIn: "3d",
})

Pass the target automation itself or its unique name in the current project. Omit the entrypoint from both calls to use "default". An automation can define each entrypoint once. Names beginning with __$ are reserved for Automate.ax. runAt accepts a Date, absolute date string, or epoch-millisecond number. runIn accepts a compact duration such as "24h" or a millisecond number. They are mutually exclusive; omitting both invokes immediately.

Get started

Guides

Concepts

Reference