How to use an action in a Scenario Builder scenario?

Scenario Builder is a new module that replaces Scenario Dialog. Actions extend scenario functionality: integrate with external systems, process data, execute complex logic.

When you need it

• You need to integrate the scenario with CRM, API, or other systems.
• You need to perform calculations, validate data, or make external requests.
• You need to send email, create a ticket, or call an external service.

What you need to know

• Action — an action from the actions library (ActionJail) that can be used in a scenario.
• Form mode — in Scenario Builder, actions are configured through a UI form instead of raw JSON. You can switch to JSON mode for manual editing when needed.
• Documentation in panel — for each action type, Node Inspector shows built-in documentation and hints for parameters.
• Test action — in the node config panel you can test the action with the current state.
• Events — the outcomes of an action (for example, create, update, error). Each event is a separate row on the node with its own arrow to the next node. The event list is in the «Events» section of Node Inspector.

Before you start

• You are logged in with integrator or administrator rights.
• You have an open scenario in Scenario Builder.
• The required action is created in the actions library (ActionJail).

Step-by-step instructions

1. Add Action node

1. On the canvas, click «+».
2. In the modal, select category Data or Main.
3. Select node type Action.
4. The node appears on the canvas.

2. Connect to previous node

1. Drag an edge from the previous node (e.g., WaitForInput) to the Action node.
2. Connect the Action to the next node according to the scenario logic.

3. Configure the action

1. Click on the Action node — Node Inspector opens on the right.
2. Select the action template from the actions library.
3. Fill in parameters through the form (fields, dropdowns, rules). Built-in documentation and hints are shown for each action type.
4. Use process variables in the format {{variable_name}}.
5. If needed, switch to JSON mode — for manual configuration editing (when the action supports this mode).

4. Change the order of events on the node (optional)

At first, events appear on the node in the order they were added. If the next nodes on the right are arranged differently, the arrows cross and the diagram is hard to read. Arrange the events in the same top-to-bottom order as the nodes they lead to:

1. Click the action node and expand the «Events» section in Node Inspector.
2. Next to an event, click the up arrow («Move Up») or the down arrow («Move Down») — the event swaps places with its neighbour.
3. Look at the canvas: the rows on the node are in the same order as in the panel, and each arrow starts from its own event. If the node has more than four events, some rows are folded under the «+N more» button — click it to see all of them.
4. Click «Publish» to save the new order.

What to know about event order:

• Event order does not affect how the bot works: where each event leads, arrow labels and colours stay the same.
• A new event — added with «Add Event» or from the «Available Events» list — appears at the bottom of the list.
• Router and Operator queue cascade nodes and the interval__start action have no reorder arrows: there the order of events affects how the scenario runs.
• Two adjacent events with the same name can't swap places — the button between them is disabled.
• The buttons are disabled while a colleague is editing the section — see Edit a scenario together with colleagues.
• Event order matters when you delete an action node: the editor connects the previous node to the next one by itself. If the node has no exit without an event, it continues the branch from the success event, or, without it, from the topmost event that has an arrow, as shown on the node.

5. Test the action (optional)

1. In Node Inspector, find the «Test action» or «Test» button.
2. You can pull state from the last run («From last run»).
3. Run the test — the result displays in the panel.

6. Publish changes

1. Click «Publish» in the toolbar. In the «Publish Scenario» window, optionally add a «Version Comment» and click «Publish».

Related materials

• Scenario Builder hub
• Built-in actions reference — common routing, operator, Custom Data, schedule, and timer actions
• Actions library (ActionJail)
• Actions reference
• Scenario Dialog — actions in scenarios — action concepts (apply to Scenario Builder too)