02.1 Scenario Setup
Saving a Scenario
After adding a scenario, it is recommended to rename the scenario (1), add a description if necessary (2), and save the changes by clicking the Save button (3). Regular saving also helps in maintaining version control and tracking the progress of your scenario development.
The Save button becomes active immediately after any changes are made to the scenario or its nodes. To avoid losing changes, remember to save your work regularly.
Running a Scenario
Run Once Scenario Execution
Before running your scenario, it needs to be configured. If your scenario is not yet configured and ready to run, you can familiarize yourself with the main setup steps in this section.
You can execute a scenario once by clicking the Run Once button. This is useful for testing and debugging your scenario to ensure it works as expected.
Depending on the trigger node:
- If the trigger node is an APP node, create an event in the external application to initiate the scenario.
- If the trigger node is Trigger on Webhook, send an HTTP request to the Trigger on Webhook node's address.
- If the trigger node is Trigger on Schedule or Trigger on Run once, no additional actions are needed.
After the scenario executes:
- Icons indicating successful execution or errors will appear in the upper right corner of the nodes. Clicking these icons provides detailed information.
- A new entry will appear in the execution history.
- The Data tab in the configuration window will display data from previous nodes.
- The Variables tab in the configuration window will display variable data if any were created in the scenario.
You can stop a one-time scenario execution by clicking the Stop button.
Automatic Scenario Execution and Activation
To enable automatic execution of a scenario, you need to activate it. At the bottom of the scenario page, there is an Active toggle switch. When the scenario is active, it will automatically execute in response to the configured triggers, such as webhooks, schedules, or application events. Activating the scenario ensures it runs continuously without manual intervention, allowing for seamless automation of your tasks.
At the bottom of the scenario page, there is an Active toggle switch to set the scenario's activity status.
Notifications about the execution results of the scenario nodes are only displayed when the scenario is manually started.
Deployment and Scenario Branches
For configuring the scenario, there are two branches:
- Development - the branch for testing the scenario's configuration and data processing results;
- Production - the branch for storing the working version of the scenario.
The Development-branch and the Production-branch of the scenario can be edited and executed independently of each other. This allows for meeting the business process requirements by using the Production-branch of the scenario while simultaneously making enhancements to the Development-branch.
To create a new Development-branch of the scenario and transfer it to the Production-branch, follow these steps:
- Save the current version of the scenario by clicking on the Save button;
- Check the availability of the next Development-branch in the list of versions;
- Click the Deploy button;
- Check the availability of the Production-branch in the list of versions.
The label "Selected" indicates the current scenario version. The label "Production" indicates the Production-branch scenario.
If necessary, you can "roll back" the Production-branch of the scenario. To do this, follow these steps:
- Select any previous version of the scenario:
- Press the Deploy button to publish the previous version of the scenario to the Production-branch:
- View the “Selected” and “Production” labels for the previous version of the scenario.
Triggers and Scenario Branches
Each scenario has a trigger node that initiates the scenario. It is important to understand how trigger nodes work depending on whether the scenario is deployed.
Trigger on Webhook
The Trigger on Webhook node initiates the scenario when an HTTP request is sent to one of the node's URL versions (Production (1) or Development (2)).
- The Production-branch of the scenario is triggered by a request sent to the Production-version URL of the Trigger on Webhook node. To ensure the request is sent successfully, you need to deploy the scenario (1) and make sure the scenario is active (2).
- The Development-branch of the scenario is triggered by a request sent to the Development-version URL of the Trigger on Webhook node. To ensure that a submitted request is accepted by the scenario and successfully processed, you need to:
(1) Either run the scenario beforehand by clicking the Run once button;
(2) Or activate the scenario using the Active toggle switch.
Trigger on Schedule
The Trigger on Schedule node initiates the Production-branch of the scenario according to the schedule configured in the node, as long as the scenario is active.
The Development-branch of the scenario does not run according to the Trigger on Schedule node's schedule, but you can still manually initiate the scenario by clicking the Run once button.
Trigger on Run once
The Trigger on Run once node initiates the Development-branch of the scenario when you click the Run once button. The Production-branch of the scenario does not start when you click the Run once button.
It is permissible to have multiple trigger nodes in one scenario. For example, use Trigger on Run once for testing the functionality of all other nodes during configuration and Trigger on Webhook for testing the entire scenario with incoming external data.
APPs Triggers
Application trigger nodes initiate the scenario differently depending on the scenario branch:
- The Production-branch of the scenario is triggered by the application trigger node at regular intervals based on the subscription plan, provided that the initiating event in the application has occurred.
In the Starter plan, trigger nodes run every 10 minutes. In the Grow plan, they run every 5 minutes. In the Prime plan, they run every 2 minutes.
Nodes with "Instant" in their name are exceptions. They are triggered immediately after the initiating event occurs in the external application.
- The Development-branch of the scenario is not triggered by the application trigger node, but you can still run the scenario once by clicking the Run once button. After this single run, the scenario will execute if the initiating event occurs in the application.
Other Settings
Aligning Nodes
At the bottom of the scenario page, there is an Align Nodes button to horizontally align the scenario chain if the nodes are connected by routes.
If the scenario nodes are not connected, the unconnected nodes will be aligned vertically.
Adding Stickers
At the bottom of the scenario page, there is an Add Sticker button to add stickers. Stickers are not required for any functions but can be used for comments or storing necessary information about the scenario. After adding a sticker, you can enter text, format it, and add links and code snippets.
You can resize a sticker by dragging (1) its edges. Right-clicking on a sticker allows you to:
- Copy (2) the sticker to duplicate it in the current or another scenario.
- Delete (3) the sticker.
