Workflows

Manually trigger a workflow

Changed on

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

  • Base URL
    https://api.avaprotocol.org/api/v1
  • Auth
    HTTP bearer

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.

triggerOutputunknown
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

Empty when status is success. On failed, a summary of the form N of M steps failed: <name>: <step.error>, … so the cause (e.g. a bundler replacement underpriced) is on this envelope, not only on GET /executions/{id}. On error, the system message.

Example response

{
  "executionId": "01JG2FE5MDVKBPHEG0PEYSDKAC",
  "steps": [
    {
      "errorDetails": {
        "token": "0x82F2Dd9a552a69f2ceD7Ff2D05c43aB8430158FB"
      }
    }
  ]
}

Changes

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status