Introduction

Once you've built a certain flow, you may want to execute it. ;) Executing a flow means running it, starting from the "root" state.

An execution can be started with the following properties:

  1. Entry Payload - the root data to be passed to the execution. Think of it as an argument for a function. As of 2020, we only allow JSON objects as entry payloads, though if you have a special requirement please do not hesitate to raise a feature request.

  2. Environment - The environment encompasses multiple key properties: - A deployment with a state machine snapshot - Secrets (which are created per-environment).

  3. Mode - you can execute a flow in the following modes: - sync - the execution will trigger states one after another, in a chain, while holding the initial invocation request alive until the flow execution is complete. - async (default) - the execution will be scheduled to start immediately, but the invocation request will end with the execution id as the response.

To learn more about how executions work, read 'Entry Payload and Routes'.

You can see all the executions under the /executions route, and use the filters to find the ones you need.