Manual start

Overview

Manual start blocks allow you to start a workflow manually from your application. You can use this block to trigger a workflow when a user performs a specific action, such as clicking a button or submitting a form. Multiple start blocks can be used within a single workflow to accommodate different entry conditions. Once a user enters a workflow, they will not be allowed to re-enter until they have exited.

To start a workflow using the manual start block, you need to call the startWorkflow() method from your application. This method requires the following parameters:

• blockKey: The key of the manual start block you want to trigger. Copy this key from the block editor in the workflow builder.

See React or JavaScript SDK documentation for more information on how to use the startWorkflow() method.

Input

A start block uses user property conditions to control how users enter the workflow. These conditions allow you to evaluate users properties to determine whether user should qualify to enter the workflow. For example, you might filter users who signed up before a certain date.

User property conditions are specified as an array where all conditions must be met for a user to enter. Each condition includes the following attributes:

• Property name: The key of the user property to evaluate (eg. createdAt).
• Data type: The type of the user property. Options include string, number, boolean, or date.
• Operator: The operator used for the comparison. The available operators depend on the data type.
• Values: The comparison values. When multiple values are specified, they are evaluated using the OR operator.

Multiple start blocks

You can use multiple start blocks within a single workflow to establish different entry conditions. Remember, once a user enters a workflow through any start block, they cannot re-enter until they exit.