Sign in

v11

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-023710598.2 KB
Workflows

Manually trigger a workflow

Simulate an operator-detected trigger fire. The server enqueues an execution; when isBlocking=true, the response waits for the execution to complete.

post/workflows/{id}:trigger

Request body

triggerType'manual' | 'fixedTime' | 'cron' | 'block' | 'event' required

Discriminator field for the Trigger union. Mirrors the proto TriggerType enum but without the TRIGGER_TYPE_ prefix.

{"stackTrail":"components:schemas:TriggerWorkflowRequest:properties:triggerOutput","oasType":"schema","type":"unknown","description":"Type-specific output payload (BlockTrigger.Output,\nEventTrigger.Output, etc.) that simulates what the operator\nwould have observed. Defined alongside execution schemas.\n"}
triggerInputInputVariables

Free-form key-value bag of values used to resolve {{variable.path}} template references inside trigger and node configs. Conventional well-known keys: settings.runner (smart wallet address), settings.chainId (chain id). camelCase keys; back-compat support for snake_case keys exists during the migration window.

isBlockingboolean

When true, wait for the execution to complete and return its result.

Response

Execution completed (blocking). Returned when isBlocking=true.

executionIdstring required

ULID identifier (26-char Crockford base32).

status'pending' | 'waiting' | 'success' | 'failed' | 'error' required

Outcome of an execution. pending is in-flight; waiting is suspended mid-workflow at an await node, durably parked until a signal arrives (a human approve/reject or an operator-observed chain event) or the wait times out — non-terminal, like pending, but distinguishable so a client can show "awaiting approval"; success is full success; failed is logical failure (e.g., a node returned an error, or a wait timed out); error is a system / infrastructure failure (e.g., RPC unreachable).

startAtinteger
endAtinteger
errorstring

Example response

{
  "executionId": "01JG2FE5MDVKBPHEG0PEYSDKAC"
}