Initialising a process flow manually with a payload

Introduction

The initialise flow (advanced) option can be used if you want to run a process flow immediately with a given payload in a single operation - it's particularly useful if you are sending data into Patchworks via the Patchworks API or a webhook and need to test a process flow with specific data.

If the virtual environments feature is enabled, you can also use the initialise flow (advanced) option to run the process flow against a given virtual environment - for more information, please refer to Testing a process flow against a virtual environment.

Need to know

  • The maximum number of characters for a single payload is 100k. Anything larger than this may cause the process flow to fail.

  • Your subscription tier determines the number of process flow runs that can be started per minute - please see Core subscription tiers for information.

  • When working with draft process flows, you cannot edit shapes while the flow is being run manually.

The steps

To initialise a process flow manually with a payload, follow the steps below.

Step 1 Access the process flow that you want to run.

Step 2 Click the initialise flow (advanced) option from the toolbar:

Step 3 A payload window is displayed:

...so you can paste in the required payload and initialise the flow:

If required, you can also choose to pass in a flow variable value. Any existing flow variables are displayed - to make a change, toggle the variable field ON and update the value as needed:

Last updated