Skip to content

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? ​

ts
optional async?: object;

The action starts work at the vendor and completes through a webhook naming its external id.

callbackTimeoutSeconds ​

ts
callbackTimeoutSeconds: number;

description? ​

ts
optional description?: string;

idempotent? ​

ts
optional idempotent?: boolean;

Repeating the action with the same input has no additional effect.


input ​

ts
input: I;

output ​

ts
output: O;

retry? ​

ts
optional retry?: RetryPolicy;

Retried by the host when idempotent is true or the caller supplies an idempotency key.


timeoutMs? ​

ts
optional timeoutMs?: number;

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

Released under the Apache-2.0 License.