Configuring Workflow Start/Stop Conditions

Suggest Edits

In addition to settings you can apply for your workflow blocks, you can set up start/stop configurations for your workflow.

To open the Start/Stop configuration menu:

  1. In your account, go to Automation → Workflows and select the type of workflows in the left-hand side menu:
  • All workflows
  • Active
  • Not active
  1. Click the launch conditions of the required workflow.

The Start/stop configuration menu opens, where you can configure the start/stop conditions for a workflow.

Setting up Start Configuration

  1. Enable the Start Configuration slide button.

  2. Select one of the following conditions:

  • Event-based
  • Regular
  • On contact field change
  1. Select the settings specific to the selected condition, as described below, then click Apply.

Selecting Event-based Settings

The event-based settings in the start configuration allow you to start the workflow upon the occurrence of a specified event.

When you select Event-based, you can choose from the following settings in the workflow start configuration:

  • Event type
  • Process unique events

Selecting Event Type

To select the event type, expand the Select event type dropdown list, scroll down, and select an event.

The workflow will start when the selected event occurs.

Selecting Process Unique Events

The process-unique events define whether to:

  • Repeat the workflow every time when an event occurs.
  • Stop the workflow after the selected event occurs once.
  • Run the workflow only once during the specified time, no matter how many times the specified event occurs during that time.

To select the required condition, select the radio button beside Process unique events.

If you select the no more than condition, enter the value in the field and select its definition from the dropdown list.

Selecting Regular Setting

When you select Regular, you can choose from the following settings in the workflow start configuration:

  • Segment. It allows you to select a segment of contacts.
  • Start. This setting defines the workflow start date.
  • Start schedule. This setting defines the frequency of a workflow.
  • Allowed start days. This setting allows you to set the specific days of a week for running a workflow.
  • Start time. This setting allows you to run the workflow for 1 hour within the specified period of time.
  • End. This setting allows you to set the workflow end date.
  • Process unique events. See Selecting Process Unique Events.

Selecting On Contact Field Change Settings

When you select the On contact field change option, the workflow starts every time when the selected field changes for a selected contact.

The workflow starts when the contact field changes as the result of the contact importing or using the following API methods:

Setting up Stop Configuration

To set up stop configuration for a workflow:

  1. Enable Stop Configuration slide button.

  2. Select one of the following conditions:

  • Event-based
  • Included in a segment
  • Order-based
  1. Select the settings specific to the selected condition, as described below, then click Apply.

Selecting Event-Based Settings

The event-based condition stops the workflow when the selected event occurs.

When you select Event-based, you have the following settings for the workflow stop configuration:

  • Exit on event
  • Event key

Configuring Exit on Event Options

To configure the Exit on event options, expand the dropdown list and select the event.

To configure additional settings for this option, select the Additional settings (cog) icon on the right-hand side and enter the corresponding values in the following fields:

  • Variable name
  • Variable description

Selecting Included in a Segment Settings

The Included in a segment condition stops the workflow when the contact is included in a specified segment.

To configure the Included in a segment options:

  1. Expand the dropdown list and select the segment. To configure additional settings for this option, select the Additional settings (cog) icon on the right-hand side and enter the corresponding values in the following fields:
  • Variable name
  • Variable description
  1. Enter either of the following values:
  • Contact phone
  • Contact email
  • Contact ID

Selecting Order Based Settings

The Order based condition stops the workflow if an order-related event occurs before the workflow starts or during a specified time after the workflow starts.

The system searches first for the Contact ID. If it is not specified, it searches for externalCustomerId if this is present in the event parameters.

To configure the Order based options:

  • Enter either of the following values:
    • Contact phone
    • Contact email
    • Contact ID
  • Enter the value in the Period field and select its definition from the dropdown list.

Updated 2 months ago