How to Use an Action in a Scenario?

Actions allow extending scenario functionality: integrating with external systems, processing data, executing complex logic. This instruction will help add and configure an action in Scenario Dialog.

When Needed

  • You need to send an HTTP request to an external API
  • You need to validate data entered by the user
  • You need to execute conditional logic (if-else, switch)
  • You need to integrate with FastLine Pro AI agents
  • You need to create a ticket or perform another system action
  • You need to use custom logic created through ActionJail

What's Important to Know

  • Action — JavaScript function that executes during scenario execution
  • Standard actions — built into the platform (98 actions), available to all bots
  • Custom actions — created through the ActionJail module for specific tasks
  • Action parameters — settings passed to the action during execution
  • Action result — value returned by the action (can be used for conditional transitions)

Prerequisites

  • You are logged in with integrator or administrator rights
  • You have an open scenario in the Scenario Dialog editor
  • You know which action is needed (standard or custom)

Step-by-Step Instructions

1. Open Scenario Editor

  1. Navigate to the Dialog module via Apps -> Dialog
  2. Select the bot and open the scenario for editing
  3. Make sure you are on the needed scenario section

2. Add Node of Type Action

  1. On the canvas, right-click or use the "Add Node" button
  2. In the modal window, select node type "Action" (or "Action")
  3. The node appears on the canvas — drag it to the desired location

3. Select Action

  1. Click on the Action node to select it — the editing panel (RightSideBar) opens on the right
  2. In the "Action Template" or "Action template" field, select the needed action from the dropdown list
  3. The list contains:
    • Standard actions — built into the platform (for example, action_validate, action_send_request)
    • Custom actions — created through ActionJail (if they exist in the system)

4. Configure Action Parameters

  1. After selecting the action, a form with parameters appears in the editing panel
  2. Fill in required parameters (marked with an asterisk *)
  3. If needed, fill in optional parameters
  4. Use variables and macros for dynamic values (for example, {{user_input}})

Example for action_send_request:

  • URL — API endpoint address
  • Method — HTTP request method (GET, POST, PUT, DELETE)
  • Headers — request headers (optional)
  • Body — request body (optional)

Example for action_validate:

  • Input — value to validate (can be a variable)
  • Type — validation type (email, phone, number, text)
  • Error message — error message

5. Configure Transitions (if needed)

  1. If the action returns a value for conditional transitions, configure edges:

    • Successful execution → connect to the node that executes on success
    • Error → connect to the error handling node
    • Conditional values → add multiple edges with different conditions (for example, for if_else)

  2. To configure conditional transitions:

    • Select an edge (connection) between nodes
    • In the edge editing panel, specify the transition condition (for example, result === 'success')

6. Save Changes

  1. Check action settings in the editing panel
  2. Click the "Save" button at the bottom of the screen or use keyboard shortcut Ctrl+S (or Cmd+S on Mac)
  3. The system saves all changes and shows a success message

What Happens After

The action is added to the scenario and will execute during bot operation. When the bot reaches this node, it will call the corresponding action function, pass parameters, and process the result.

How to Verify It Worked

  • Check that the Action node displays on the canvas
  • Make sure the action is selected in the editing panel
  • Check that all required parameters are filled
  • Make sure the node is connected to other nodes through edges
  • Try opening the scenario again — all changes should be saved

Common Errors and Solutions

Problem: Action does not execute or returns an error

  • Solution: Check if all required parameters are filled correctly, if URL/endpoints for HTTP requests are specified correctly

Problem: Cannot find the needed action in the list

  • Solution: Check if the action exists in the system (standard actions are always available, custom ones — only if created through ActionJail)

Problem: Action executes, but result is not processed

  • Solution: Check if conditional transitions (edges) after the action are configured correctly