On invocation

onInvocation<T>() receives a payload from another automation. Name the entrypoint when the automation accepts different invocation types. T is compile-time only; onInvocation doesn’t validate the payload at runtime.

automations/receive-order.automation.ts

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

interface OrderInvocation {
  orderId: string
}

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

  markSignificant(invocation.orderId)
})

markSignificant(invocation.orderId) keeps each run whose invocation emits an orderId in the default Recent runs view without an external write. Invoke it from another automation with invokeAutomation:

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

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

Built-in triggers

Built-in actions

Runtime utilities

Integrations