Interface: ActionSpec<I, O>

One callable action: zod schemas for its input and output, and its limits.

Type Parameters

I

I extends z.ZodType = z.ZodType

O

O extends z.ZodType = z.ZodType

Properties

async?

optional async?: object;

The action starts work at the vendor and completes through a webhook naming its external id. The run waits callbackTimeoutSeconds at most (1 s to 7 days); an answer may ask for less, pending(externalId, { callbackTimeoutSeconds }).

callbackTimeoutSeconds

callbackTimeoutSeconds: number;

---

description?

optional description?: string;

---

idempotent?

optional idempotent?: boolean;

Repeating the action with the same input has no additional effect. Only such an action is sent again after a timeout or an unreachable runner.

---

input

input: I;

---

mappable?

optional mappable?: string[];

The input fields run data may fill, as JSON Pointers (['/variables']), each with what lies under it: a step's or rule's inputMapping that sets another field is refused before the action runs. Absent, run data may fill any field. Name them when the input is a template the action fills, so run data never writes the template.

---

output

output: O;

---

outputFromInput?

optional outputFromInput?: OutputFromInput[];

The output fields whose shape a call's input gives, for the paths a step's or rule's editor offers (OutputFromInput): an answer whose JSON Schema the step wrote, the answers to the questions it asked.

---

retry?

optional retry?: RetryPolicy;

Retried by the host when idempotent is true or the caller supplies an idempotency key; after a timeout or an unreachable runner only when idempotent is true, since the action's requests may have gone out.

---

timeoutMs?

optional timeoutMs?: number;

Deadline of one attempt, the whole call included (100 ms to 120 s; 15 s by default).