Requesting a flow run

A flow with an API trigger can be started over the API. When you request a run, you can pass arguments that the flow's steps receive as input.

Argument casing

Argument names are case-insensitive with respect to style: you can send them in either PascalCase or snake_case, and Attlaz normalises them. For example, OrderId and order_id are treated the same, so you can use whichever convention matches your codebase.

{
  "arguments": {
    "order_id": "12345",
    "dryRun": true
  }
}

Requesting a flow run requires a valid access token — see Authentication. The run is queued and processed like any other flow run; it starts in Pending and moves to Running once a runner begins executing it (see Flows).