Start a flow
flow_startStarts a flow run and returns the callback URL a participant must reach, failing immediately if the flow lacks configuration or ownership.
Instructions
Open a run of one flow and report what its first step needs. Returns the callback URL the participant under test must be able to reach — every payload this server sends advertises it as bap_uri or bpp_uri, so a participant that cannot reach it will never call back. Fails immediately if the flow has no mock config or any step with no owner, so a flow that cannot be driven is rejected before anything is sent. transaction_id comes back null: it belongs to whoever sends the flow's first action, so when that is the participant it is theirs to choose and does not exist yet. Drive the run by flow_id with flow_proceed and flow_await, which report the id once it exists.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| flow_id | Yes | Flow to run, as listed by catalog_list_flows. | |
| session_id | Yes | Session returned by session_create. | |
| auto_advance | No | Override the session default. When on, the receiver chains this mock's own steps as soon as the participant answers, pausing only for inputs, forms and errors. | |
| transaction_id | No | Resume a transaction that already exists. Omit it — a new run does not have an id yet, and inventing one here would be wrong whenever the participant sends the flow's first action, because then the id is theirs to choose. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| events | No | What has happened in this session since your last call — the participant's callbacks, steps sent automatically, refusals, form submissions. Attached to every session-scoped result and delivered exactly once, so read it here instead of polling. Absent when nothing happened. `more` above zero means call record_get_events for the rest. | |
| attempt | Yes | Which try this is. 1 unless the run has been restarted; every attempt gets its own transaction_id. | |
| flow_id | Yes | Address this run by (session_id, flow_id) from here on. | |
| outcome | Yes | What the first step of the flow needs. | |
| mock_role | Yes | The role this server plays in this flow. | |
| session_id | Yes | ||
| auto_advance | Yes | ||
| callback_url | Yes | What the participant must call back on. Advertised as bap_uri/bpp_uri in every payload this mock sends. | |
| transaction_id | Yes | Null for a new run: the transaction id belongs to whoever sends the flow's first action, so it does not exist until that action crosses the wire. Drive the run with flow_id until then; every loop answer reports the id once it is known. |