Documentation
  • English
  • Українська
  • English
  • Українська
  • Getting Started

    • ConnectiveOne Documentation
  • Channel Configuration

    • Channels

      • Integrator — Channels Configuration Hub
      • Explanations

        • What is ConnectiveOne Widget
        • Widget JavaScript API
      • Instructions

        • How to Configure IP Blocking Message?
        • How to Configure Widget in Settings
        • How to Connect Facebook Messenger and Instagram to ConnectiveOne
        • How to Connect Gmail to ConnectiveOne
        • How to Connect Outlook to ConnectiveOne
        • How to Connect Telegram to ConnectiveOne
        • How to Connect Numbered Viber, Telegram, and WhatsApp via e-chat
        • How to Connect Viber to ConnectiveOne
        • How to Connect WhatsApp to ConnectiveOne
        • How to Customize Widget Colors
        • How to Manage Widget from Website
        • How to Pass Parameters from Website to Scenario
        • How to Configure Sending SMS via Alpha SMS
        • How to Configure Sending Viber/SMS via Infobip
        • How to Connect Widget to Website
        • How to Use Custom Code for Widget
        • How to Work with Widget on SPA Applications
  • Request Processing

    • Operator Panel (OperatorLine)

      • Operator — OperatorLine Scenarios Hub
      • Supervisor — OperatorLine Scenarios Hub
      • Administrator — OperatorLine Scenarios Hub
      • Integrator — Operator Panel Hub for OperatorLine
      • Explanations

        • About Processing Requests in ConnectiveOne
        • About Auto-Distribution of Dialogs Between Operators
        • About Automatic Connection of Free Operator to New Dialog
        • About Connecting Chat with Operator Through Operator Panel
        • About Redistribution of Chats from Operator
      • Instructions

        • Change Request Status
        • Create Filter
        • Create Folder
        • Create Outbound Request
        • How to Create a Ticket?
        • How to Link Tickets to Each Other?
        • Manage Folders
        • How to Edit Ticket Fields?
        • How to Manage Ticket Watchers?
        • Monitor Operator Statuses
        • Open Request
        • Reorder Folders
        • How to Reply to a Client?
        • Set Topic and Tags
        • Use Copilot
        • Use Quick Replies
        • How to View Active Dialogs in Client Card?
        • View Chat List
        • View Chats in Table
        • View Request Queue
        • How to View Ticket Logs?
        • How to View Ticket SLA Metrics?
    • Profile

      • Operator — Profile Scenarios Hub
      • Administrator — Profile Scenarios Hub
      • Instructions

        • How to Change Interface Language?
        • Configure Folders
        • Configure Notifications
        • Configure Quick Replies
        • Configure Signature
    • BroadcastUsers (Clients)

      • Operator — BroadcastUsers Scenarios Hub
      • Integrator — BroadcastUsers Scenarios Hub
      • Administrator — BroadcastUsers Scenarios Hub
      • Instructions

        • Create Segment by Filters
        • Edit Client Data
        • Export Client Data
        • Filter Clients
        • Manage Subscription
        • How to Find a Client?
        • Search Clients by File
        • Send Broadcast to Selected Clients
        • How to View a Client Card?
        • View Client Channels
  • Broadcasts

    • Broadcast

      • Operator — Broadcast Hub
      • Integrator — Broadcast Settings Hub
      • Analyst — Broadcast Analytics Hub
      • Instructions

        • How to Activate a Scheduled Broadcast?
        • How to Add Images to Broadcasts?
        • How to Check Broadcast Status?
        • How to Configure an Automatic Broadcast?
        • How to Configure Alias in Broadcasts?
        • How to Configure Broadcast Limits?
        • How to Create a Broadcast Template?
        • How to Create a Broadcast?
        • How to Create a Broadcast Topic?
        • How to Deactivate a Broadcast Topic?
        • How to Edit a Broadcast Draft?
        • How to Edit a Broadcast Topic?
        • How to Export Broadcast Results?
        • How to Format Messages in Broadcasts?
        • How to Launch a Broadcast Immediately?
        • How to Save a Broadcast as a Draft?
        • How to Find Contacts by File?
        • How to Send a Broadcast from the Clients Module?
        • How to Configure a Scheduled Broadcast?
        • How to Configure Subscription to Broadcast Topics?
        • How to View a Broadcast Report?
        • How to View Broadcast Results?
        • How to View Click Statistics?
        • How to View Delivery Statistics?
        • How to View Open Statistics?
  • Automation

    • Scenario Dialog (Legacy)

      • Integrator — Scenario Dialog Scenarios Hub
      • Explanations

        • Actions in Scenarios — What They Are and How They Work
        • About Using autobroadcast__create Action in Scenarios
        • About Copying Existing Bot Scenario
        • About ConnectiveOne Integration with Corezoid Through Operator Panel
        • About Displaying Images to User
        • About Email Categorization Using AI
        • About Facebook Ads Referral Tags
        • About Launching Scenario from Facebook Ads
        • About HTML Text Formatting in Telegram and Widget
        • About Inline Keyboard in Telegram and Widget
        • About Configuring Alias for Outgoing Dialog
        • About Payment via Bot
        • About Telegram Group Bots
        • About Telegram WebApp in Scenarios
        • About Viber Keyboard Styling
        • About Viber Start Message
      • Instructions

        • How to Add Translations to a Scenario?
        • How to Create a New Bot Scenario?
        • How to Create a Scenario Section?
        • How to Edit an Existing Bot Scenario?
        • How to Export or Import a Scenario?
        • How to Use an Action in a Scenario?
        • How to View and Restore Scenario Versions?
    • ActionJail

      • Operator — ActionJail Scenarios Hub
      • Instructions

        • How to Create and Maintain an Action in ActionJail (Administrator)
        • How to Clone an Action in ActionJail
        • How to Quickly Find an Action in ActionJail
        • How to Connect an ActionJail Action to a Bot Scenario (Integrator)
      • Reference

        • Actions Reference — Actions Guide
    • Integrations

      • Integrator — ConnectiveOne Integrations Hub
      • Explanations

        • Launch Scenario via Deeplink
        • Transfer UTM Tags Through Messages
        • What are ConnectiveOne Integrations
      • Instructions

        • How to Integrate Operator Panel as Widget in CRM/ERP
        • How to Configure Product Name for Zoho CRM
        • How to Integrate External System via Custom Channel
        • How to Get Data from API Using send_request
        • How to Send Data from ConnectiveOne via send_request
        • How to Configure User Subscription to Notifications
        • How to Launch Bot Scenario via API call_node
        • How to Integrate ConnectiveOne with eSputnik
        • How to Send Phone Broadcast via Route
        • How to Use ConnectiveOne API
        • How to Configure Operator Panel Webhook
      • Reference

        • API Reference — ConnectiveOne API Reference
    • Custom Data

      • Integrator — Custom Data Scenarios Hub
      • Administrator — Custom Data Scenarios Hub
      • Analyst — Custom Data Scenarios Hub
      • Instructions

        • Add Field to Model
        • How to Configure Field Display in Custom Data?
        • Configure Field Type
        • How to Create an Association Between Tables in Custom Data?
        • Create Group
        • How to Create a Data Model?
        • Edit Model
        • Export Filtered Data
        • How to Export Model Data?
        • How to Extend Client Contacts Table Through Custom Data?
        • How to Find Records by Filters?
        • Import Data from File
        • How to Save Data from Scenario to Custom Data?
        • Sort Records
        • How to Use AI Magic to Create Custom Data Models?
        • How to Use custom_modules__get Action to Get a Record?
        • How to Use Autocomplete Search in Custom Data?
        • How to Use custom_modules__set Action to Create a Record?
        • Validate Data
        • View Model Records
    • FileManager

      • Operator — FileManager Scenarios Hub
      • Instructions

        • How to Create a Jira Task with a File?
        • How to Delete a File or Folder?
        • How to Navigate to a Folder?
        • How to Upload a New File?
        • How to View the File List?
  • Artificial Intelligence

    • FastLinePro

      • Integrator — FastLinePro Scenarios Hub
      • Administrator — FastLinePro Scenarios Hub
      • Instructions

        • Activate KB Plugin
        • How to Check AI Agent Response in Scenario?
        • Check Synchronization Status
        • Configure Agent Prompt
        • How to Configure Agent Variables in FastLinePro?
        • How to Configure Chunking in FastLinePro Knowledge Base?
        • Configure KB Plugin Synchronization
        • Configure Knowledge Synchronization
        • How to Connect Knowledge Base to AI Agent in FastLinePro?
        • Create Agent
        • How to Create a Chatbot?
        • How to Create a Knowledge Base?
        • Deactivate KB Plugin
        • How to Prepare a File for FastLinePro Knowledge Base?
        • Run KB Synchronization
        • Update KB Files
        • Upload Files to KB
        • How to Use action_fastline_pro Action in Scenario?
    • Quality Assurance

      • Supervisor — Quality Assurance Scenarios Hub
      • Administrator — Quality Assurance Scenarios Hub
      • Analyst — Quality Assurance Scenarios Hub
      • Instructions

        • How to Adjust AI Assessment Criteria?
        • How to Approve Assessment?
        • Assess Request
        • Conduct Quality Check
        • How to Create a New Dialogue Assessment?
        • Export Assessments
        • Filter Assessments
        • Use Checklist
        • View Assessment Details
        • How to View Assessments List and Find the Needed One?
        • View Quality Dashboard
        • View Quality Reports
  • Statistics

    • Statistics

      • Supervisor — Statistics Scenarios Hub
      • Administrator — Statistics Scenarios Hub
      • Analyst — Statistics Scenarios Hub
      • Instructions

        • Apply Filters to Report
        • How to Configure CSAT (Customer Satisfaction) in Statistics?
        • How to Create and Configure a Funnel in Statistics?
        • Create Detailed Report
        • Create Funnel
        • Export Report
        • How to Export Statistics Data?
        • Set Target Metrics
        • View Daily Report
        • View Dashboard
        • How to View Metabase Dashboards in Statistics Module?
        • How to View Operator Schedule in Statistics?
        • View Shift Report
      • Reference

        • Statistics Metrics — Reference
  • Administration

    • Settings

      • Supervisor — Operator Panel Settings Hub
      • Administrator — System Settings Hub
      • Instructions

        • How to Activate or Deactivate a Bot?
        • How to Configure Authentication and Access Management?
        • How to Configure a Bot?
        • How to Configure Operator Calendars?
        • How to Configure Chat Parameters?
        • How to Configure Client Card Fields?
        • How to Configure Client Fields?
        • How to Configure File Parameters?
        • How to Configure Hot Keys?
        • How to Configure Instance Parameters?
        • How to Configure Operators in Chats?
        • How to Configure Roles and Access Rights?
        • How to Configure Styles and Scripts?
        • How to Configure Ticket Topics?
        • How to Configure General System Settings?
        • How to Configure Ticket Parameters?
        • How to Configure Timers for Chats?
        • How to Configure User Fields?
        • How to Create a New Bot?
        • How to View Bots List?
        • How to View System Status?
        • How to View Users List?
      • Reference

        • What Are Server Requirements for Hosting ConnectiveOne?
    • Access Recovery

      • Access Recovery — Scenarios Hub
      • Instructions

        • How to Enable Password Recovery Flow (Administrator)
        • How to Generate a Password Reset Link Manually (Administrator)
        • How to Reset Password Through "Forgot Password?"

Actions Reference — Actions Guide

Complete reference for all standard actions in ConnectiveOne. Actions are functions that execute during bot scenario execution to extend functionality, integrate with external systems, and process data.

What are actions?

Actions are JavaScript functions that execute during bot scenario execution. When a bot reaches an Action type node in a scenario, it calls the corresponding function, passes parameters to it, and processes the result.

Total number of standard actions: 98

Types of actions

  • Standard actions — built into the ConnectiveOne platform, available to all bots (98 actions)
  • Custom actions — created through the ActionJail module for specific project tasks

💡 More details: For creating custom actions, see the ActionJail module and instructions for creating actions

Usage in scenarios

Actions are used in:

  • Scenario Dialog — through Action type nodes
  • Scenario Builder (Beta) — through Action type nodes with template support

💡 More details: For using actions in scenarios, see the instructions for Scenario Dialog and explanation about actions


Standard actions by groups

Action Jail (1)

NameSystem IDDescriptionConfigurationReturns
Logaction_logLogs a message to the console for debugging purposes. This is a simple debugging action that outp...{}Returns undefined - Action completes silently

Api (1)

NameSystem IDDescriptionConfigurationReturns
API Call Nodeaction_api__callnodeCalls an external API endpoint to execute a specific node (connector) in another bot. This action...{ "bot_id": "", "connector_alias": "", "chat_id": "", "channel": "", "data": ...ok - The API call was successful and the target node exec...

Autobroadcast (2)

NameSystem IDDescriptionConfigurationReturns
Autobroadcast Createaction_autobroadcast__createCreates a scheduled autobroadcast message for the current user. The action allows scheduling mess...{ "template_id": null, "alias": null, "one_time": false, "send_after": null, ...success - Autobroadcast was successfully created and sche...
Autobroadcast Removeaction_autobroadcast__removeRemoves scheduled autobroadcast messages for the current user. The action can remove all autobroa...{ "template_id": null, "alias": null }success - Autobroadcast were successfully removed

Broadcast (3)

NameSystem IDDescriptionConfigurationReturns
Broadcast Subscribeaction_broadcast__subscribeSubscribes the current user to a broadcast topic. The action creates a subscription relationship ...{ "template_id": null, "topic_id": null, "time": null }success - User was successfully subscribed to the broadca...
Broadcast Unsubscribeaction_broadcast__unsubscribeUnsubscribes the current user from a broadcast topic. The action removes the subscription relatio...{ "topic_id": "*" }success - User was successfully unsubscribed from the topic
Broadcast Subscribedaction_broadcast__subscribedChecks if the current user is subscribed to a broadcast topic. The action verifies the subscripti...{ "topic_id": null }success - User is subscribed to the specified topic

Core Actions (63)

NameSystem IDDescriptionConfigurationReturns
Check Languageaction_check_languageChecks if a language code has been selected for the current user. The action verifies if selected...{}defined - Language code is set in state
Set Languageaction_set_languageSets the user's selected language code. The action validates the language code against available ...{}success - Language was successfully set and validated
Get Languageaction_get_languageRetrieves the currently selected language code for the user. The action checks user constants and...{}Returns the language code - Language code such as "en", ...
Get Channelaction_get_channelReturns the messaging channel through which the current user is communicating. The action returns...{}Returns the channel name - Channel name such as "telegra...
Validateaction_validateValidates user input or constant values against specified validation rules. The action supports m...[ { "constant": null, "type": null, "pattern": null } ]success - All validations passed successfully
Test Listaction_test_listGenerates a test list object with 7 items for testing purposes. The action creates a list structu...{}Returns list object with structure:
Generate Listaction_generate_listGenerates a formatted list object from an array stored in user constants. The action processes ar...{ "list": "", "output": "", "mapping": null }Returns undefined - Action completes silently
Get Commandaction_get_commandProcesses commands received from messengers in the form /commandname or passed through deeplinks....{}Returns the command name - Command name such as "start",...
Get User Inputaction_get_user_inputExtracts and processes user input from the current message, including text, files, mentions, and ...{}bot_mentioned - Bot was mentioned in the message
Send Requestaction_send_requestSends an HTTP request to an external system. The action supports all HTTP methods, custom headers...{ "url": "", "method": "POST", "data": {}, "headers": {}, "basic_auth": { "lo...ok - HTTP request was successfully sent and received vali...
Create Hashaction_create_hashGenerates a cryptographic hash from a value stored in user constants combined with a secret key (...{ "key_in_const": "idcustomer", "secret_key": "", "algorithm": "sha1", "diges...success - Hash was successfully generated and stored in t...
Send Meaction_send_meSends an HTTP request to an external URL with chat_id and channel automatically included in the r...{ "url": "", "method": "POST", "data": {}, "headers": {} }ok - HTTP request was successfully sent and received vali...
Call Nodeaction_call_nodeCalls a node (connector) in the current bot by making an HTTP POST request to the /kw/api/call_no...{ "alias": "", "data": {} }This action does not return a value . It's a fire-and-for...
If Elseaction_if_elsePerforms conditional branching based on variable states and expressions. The action evaluates con...{ "if": {}, "elseif": {}, "else": {} }Returns event name - Event name specified in the matched...
Switchaction_switchEvaluates multiple conditional expressions and returns the first matching event name. The action ...{ "event_name1": "{{param1}}>2", "event_name2": "{{param2}}<{{param3}}" }Returns event name - First event name whose condition ev...
Setaction_setSets or modifies user constants with support for placeholder replacement, mathematical expression...{ "param1": "value1", "param2": "{{param1}}+2" }default - All constants were successfully set
Set Current Dateaction_set_current_dateSets the current date and time as a JavaScript Date object in a user constant. The action creates...{ "set_to": "current_date" }default - Current date was successfully stored in constant
Menu Slideraction_menu_sliderGenerates a slider/pagination structure for menu navigation with multiple pages. The action creat...{ "cycle": false }Returns slider object - Slider structure with total and ...
Send Photoaction_send_photoSends photos to the user from URLs specified in node JSON configuration or from constants. The ac...{ "photo1": "https://example.com/photo1.jpg", "photo2": "{{photo_url}}" }Returns result from generalPhotosHandler - Typically succ...
Send Videoaction_send_videoSends videos to the user from URLs specified in node JSON configuration. The action parses video ...{ "video1": "https://example.com/video1.mp4", "video2": "{{video_url}}" }Returns result from generalVideoHandler - Typically succe...
Send Fileaction_send_fileSends files to the user from URLs specified in node JSON configuration. The action parses file UR...{ "file1": "https://example.com/file1.pdf", "file2": "{{file_url}}" }Returns result from generalFileHandler - Typically succes...
Send Emailaction_send_emailSends email messages via SMTP. The action supports HTML email content, placeholder replacement, d...{ "subject": "", "to": "", "html": "", "from": null, "service": null, "host":...success - Email was successfully sent
Loop Startaction_loop_startStarts iterating over an array of data, processing each item sequentially. The action initializes...[]success - Loop successfully started and first item is ava...
Loop Endaction_loop_endChecks if the loop iteration is complete or if more items need to be processed. The action verifi...{}success - Loop is complete, all items have been processed
Check Scheduleaction_check_scheduleChecks if the current time falls within the operator's working hours. The action validates the cu...{ "morning_time": null, "evening_time": null, "weekends": null, "timezone": "...success - Current time falls within working hours and it'...
Send Stickeraction_send_stickerSends a sticker to the user through the messaging channel. The action retrieves the channel-speci...{ "telegram_sticker": null, "viber_sticker": null, "facebook_sticker": null }Returns undefined - Sticker was successfully sent
Clear Constantaction_clear_constantClears user constants and related context data that match specified key prefixes. The action remo...{ "module_name": "" }success - Constants and context data were successfully cl...
Goto Aliasaction_goto_aliasNavigates to a scenario node identified by its alias. The action resolves the alias to a node pos...{ "alias": "" }Returns undefined - Action completes silently
Add To Cartaction_add_to_cartAdds an item to a shopping cart stored in user constants. The action retrieves item information f...{ "item_model": "", "item_id": "", "price": "", "count": "1", "attributes": "...success - Item was successfully added to the cart
Remove From Cartaction_remove_from_cartRemoves an item from a shopping cart stored in user constants. The action identifies the item by ...{ "item_model": "", "item_id": "", "save_to": "cart" }success - Item was successfully removed from cart and tot...
Sleepaction_sleepPauses execution for a specified duration and shows a typing indicator to the user. The action se...{ "delay": 10 }success - Delay completed successfully
Scan Barcodeaction_scan_barcodeScans a barcode from an image URL using Quagga barcode reader library. The action downloads the i...{ "source_url": "", "type": "ean13", "set_to": null }recognized - Barcode was successfully scanned and value s...
Scan QRaction_scan_qrScans a QR code from an image URL using jsQR library. The action downloads the image, processes i...{ "source_url": "", "set_to": null }recognized - QR code was successfully scanned and data st...
Generate Barcodeaction_generate_barcodeGenerates a barcode image from text data using various barcode types. The action creates a PNG im...{ "code": "", "type": "", "height": 10, "scale": 3, "includetext": true, "tex...generated - Barcode was successfully generated and image ...
Custom Modules Listaction_custom_modules_listRetrieves a list of distinct values from a specific field in a custom module, formatted for use i...{ "module_name": "", "field": "", "bot_id": null, "filters": null, "limit": 50 }Returns a list object with structure:
Existing Chatroomaction_existing_chatroomChecks if an active chat room exists for the current user. The action searches for a chat room ma...{}exists - An active chat room exists for the current user
Close Chatroomaction_close_chatroomCloses an operator chat room by updating its status. The action finds the chat room by ID (from o...{ "chat_room_id": null }success - Chat room was successfully closed
Create Messageaction_create_messageCreates a message in an operator chat room. The action creates messages from either clients or us...{ "id": "", "message": "", "message_type": "text", "user_id": null }success - Message was successfully created in the chat room
Get Client By Chat Room Idaction_get_client_by_chat_room_idRetrieves client information associated with a chat room. The action finds the client participant...{ "chat_room_id": null }success - Client information was successfully retrieved a...
Get Chat Room Messagesaction_get_chat_room_messagesRetrieves messages from a chat room with pagination support. The action fetches messages from the...{ "filters": { "chat_room_id": null }, "pagination": { "page_size": 10, "curr...success - Messages were successfully retrieved and stored...
Fastline Completionaction_fastline_completionGenerates AI text completion using chat completion APIs without knowledge base search. The action...{ "user_input": null, "provider": null, "model": null, "apiKey": null, "opena...Returns the generated completion text - AI completion wa...
Fastlineaction_fastlineSearches for answers in the knowledge base using vector similarity search and generates AI-powere...{ "user_input": null, "bot_id": null, "provider": null, "model": null, "apiKe...success - Answer was found, AI response generated success...
Fastline Searchaction_fastline_searchSearches the knowledge base using vector similarity search without generating AI responses. The a...{ "user_input": null, "bot_id": null, "provider": null, "model": null, "apiKe...success - Search completed successfully
Fastline Summarizeaction_fastline_summarizeGenerates AI-powered summaries of chat room conversation history. The action retrieves recent dia...{ "prompt": "", "chat_room_id": null, "messages_count": 5, "provider": null, ...success - Summary was successfully generated and stored
Fastline Transcribeaction_fastline_transcribeTranscribes audio/voice messages into text using AI voice transcription services. The action proc...{ "user_input": null, "bot_id": null, "read_from": null, "set_to": "voice_res...success - Audio was successfully transcribed and result s...
Fl Transfer To Skill Groupaction_fl_transfer_to_skill_groupTransfers a chat room from Fastline AI operator to a skill group, which automatically distributes...{ "skill_group_id": null, "skill_group_alias": null }success - Chat room was successfully transferred to an op...
Fl Transfer To Operatoraction_fl_transfer_to_operatorTransfers a chat room from Fastline AI operator to a specific human operator. The action removes ...{ "operator_id": null, "operator_email": null }success - Chat room was successfully transferred to the o...
Fastline Proaction_fastline_proInteracts with Fastline Pro AI agents using the Dify API. The action sends queries to configured ...{ "agent_name": "", "user_input": null, "conversation_id": null, "inputs": {}...Returns the agent's response text - Agent response was s...
Meta Typeaction_meta_typeDetermines the type of Meta (Facebook/Instagram) message interaction. The action checks if the me...{}post_comment - Message is a comment on a post
Card Pay Block Scenarioaction_card_pay_block_scenarioSets the payment status to active in the user request object, blocking the scenario flow until pa...{}success - Payment status was successfully set to active
Card Payaction_card_payGenerates a payment URL for card payments and stores it in user constants. The action constructs ...{}success - Payment URL was successfully generated and stor...
Apple Google Payaction_apple_google_paySends an Apple Pay or Google Pay payment request through Viber using LiqPay payment gateway. The ...{ "description": "", "product_name": "" }success - Payment request was successfully sent to the us...
Verify Online Paymentaction_verify_online_paymentVerifies the status of an online payment transaction. The action checks the payment code from the...{}success - Payment was successful
Tickets Createaction_tickets_createCreates a new ticket in the tickets system with custom field collection, operator connection, and...{ "subject_alias": "", "additional_fields": {}, "keep_original_message": fals...success - Ticket was successfully created
Tickets Create V2action_tickets_create_v2Creates a new ticket using an improved service-based architecture. This is an enhanced version of...{ "subject_alias": "", "additional_fields": {}, "keep_original_message": fals...success - Ticket was successfully created
Chatroom Updateaction_chatroom_updateUpdates the status of an operator chat room. The action finds a chat room by ID, updates its stat...{ "chat_room_id": "", "status_name": "" }success - Chat room was successfully updated with the new...
Tickets Updateaction_tickets_updateUpdates an existing ticket with new field values, assignment changes, status updates, and watcher...{ "chat_room_id": null, "assignee_id": null, "priority_id": null, "status_nam...success - Ticket was successfully updated
Get Ticket Infoaction_get_ticket_infoRetrieves ticket information from the tickets module based on ticket ID. The action fetches ticke...{ "ticket_id": null }success - Ticket information was successfully retrieved a...
My Chatrooms Listaction_my_chatrooms_listRetrieves a list of active chat rooms for the current user/client. The action finds the client by...{}Returns undefined - Chat rooms list was successfully retr...
Return To Chatroomaction_return_to_chatroomReturns the user to a previously active chat room in the operator panel. The action retrieves the...{ "alias_return_scenario": null }Returns undefined - Chat room was successfully restored a...
Tickets Clear Inputaction_tickets_clear_inputClears all custom field constants from user state that are associated with a specific subject. Th...{ "subject_alias": "" }success - Custom field constants were successfully cleared
Tickets Create Wrappedaction_tickets_create_wrappedCreates a ticket using phone-based context switching. This is a wrapper around action_tickets_cre...{ "subject_alias": "" }Returns result from action_tickets_create - success, bann...
Tickets Listaction_tickets_listRetrieves a filtered and paginated list of tickets from the database. The action supports multipl...{ "filters": { "reporter_id": null, "assignee_id": null, "chat_room_id": null...success - Ticket list was successfully retrieved and stor...

Custom Modules (4)

NameSystem IDDescriptionConfigurationReturns
Custom Modules Setaction_custom_modules__setCreates a new custom module instance in the database. The action collects field values from user ...{ "module_name": "", "bot_id": null, "fields": null, "set_to": null }success - Custom module instance was successfully created...
Custom Modules Updateaction_custom_modules__updateUpdates an existing custom module instance in the database. The action retrieves the instance by ...{ "module_name": "", "bot_id": null, "fields": null, "set_to": null }success - Custom module instance was successfully updated...
Custom Modules Getaction_custom_modules__getRetrieves a custom module instance from the database based on filters. The action searches for a ...{ "module_name": "", "bot_id": null, "filters": null, "order": null, "set_to"...success - Custom module instance was successfully retriev...
Custom Modules Exportaction_custom_modules__exportExports custom module instances to a file in various formats (CSV, JSON, etc.). The action retrie...{ "module_name": "", "bot_id": null, "format": "csv", "filename": "filename",...success - File was successfully exported and file URL sto...

Esputnik (1)

NameSystem IDDescriptionConfigurationReturns
Esputnik Push Contactaction_esputnik__push_contactPushes contact information to the Esputnik email marketing service. The action sends the current ...{}success - Request was successfully sent to Esputnik endpo...

Files (1)

NameSystem IDDescriptionConfigurationReturns
Files Getaction_files__getRetrieves file information for the current user from the file manager database. The action search...{ "name": null }success - Files were found and stored in the 'files' cons...

Interval (4)

NameSystem IDDescriptionConfigurationReturns
Interval Endaction_interval__endStops and removes a specific inactivity timer for the current user. The action clears the timer f...{}Returns undefined - Timer was successfully stopped and re...
Interval End Allaction_interval__end_allStops and removes all inactivity timers for the current user across all sections. The action clea...{}success - All timers were successfully stopped and removed
Interval Startaction_interval__startStarts a timer to monitor user inactivity and automatically route users to different scenario nod...{ "type": "inactive", "tick": 30, "end": null }error - Action failed due to missing parameters or invali...
Interval Lastaction_interval__lastReturns the user to the last scenario position before an inactivity timer triggered. The action u...{}Returns undefined - Action completes silently

Language (2)

NameSystem IDDescriptionConfigurationReturns
Language Setaction_language__setSets the user's selected language code. The action validates the language code against available ...{}success - Language was successfully set and validated
Language Getaction_language__getRetrieves the currently selected language code for the user. The action checks user constants and...{}Returns the language code - Language code such as "en", ...

Loop (2)

NameSystem IDDescriptionConfigurationReturns
Loop Startaction_loop__startStarts iterating over an array of data, processing each item sequentially. The action initializes...[]success - Loop successfully started and first item is ava...
Loop Endaction_loop__endChecks if the loop iteration is complete or if more items need to be processed. The action verifi...{}success - Loop is complete, all items have been processed

Operator Panel (4)

NameSystem IDDescriptionConfigurationReturns
Operator Panel Connect To Operator With Msgaction_operator_panel__connect_to_operator_with_msgCreates a new chat room in the operator panel and connects the user to an operator, optionally se...{ "subject_alias": null, "auto_connect_operator": false, "assigned_operator":...success - Chat room was successfully created and user con...
Operator Panel Clear Dataaction_operator_panel__clear_dataClears all user constants from the current state. The action resets the const object to an empty ...{}Returns undefined - Action completes silently
Operator Panel Nps Confirm Answeraction_operator_panel__nps_confirm_answerSaves NPS (Net Promoter Score) survey answers to the database. The action collects all non-empty ...{}success - NPS answers were successfully saved to database
Operator Panel Get Last Dialogaction_operator_panel__get_last_dialogRetrieves the complete dialog (messages and participants) from the last chat room for the current...{ "format": "json", "set_to": null }success - Dialog was successfully retrieved and stored in...

Registered Users (3)

NameSystem IDDescriptionConfigurationReturns
Registered Users Check Phoneaction_registered_users__check_phoneValidates and normalizes phone numbers for user registration. The action extracts phone numbers f...{}success - Phone number was successfully extracted and nor...
Registered Users Setaction_registered_users__setCreates or updates a registered user in the database. The action collects registration data from ...{ "check_by_phone": false, "active": 1, "anonym": 0 }success - User was successfully created or updated in dat...
Registered Users Getaction_registered_users__getRetrieves a registered user from the database and loads their data into constants. The action fin...{ "check_by_phone": false }success - User was successfully found and data loaded int...

Schedule (1)

NameSystem IDDescriptionConfigurationReturns
Schedule Checkaction_schedule__checkChecks if the current time falls within specified working hours and weekday constraints. The acti...{ "morning_time": null, "evening_time": null, "weekends": null, "timezone": "...success - Current time is within working hours and not on...

Statistic (1)

NameSystem IDDescriptionConfigurationReturns
Statistic Setaction_statistic__setSaves NPS (Net Promoter Score) or quality survey statistics to MongoDB. The action retrieves the ...{ "type": "nps" }success - Statistics were successfully saved to database

Subscription (3)

NameSystem IDDescriptionConfigurationReturns
Subscription Setaction_subscription__setSubscribes the user to a broadcast topic. The action calls the broadcast module's subscribe funct...{ "template_id": null, "topic_id": null, "time": null }success - User was successfully subscribed to the topic
Subscription Removeaction_subscription__removeUnsubscribes the user from one or all broadcast topics. The action calls the broadcast module's u...{ "topic_id": "*" }success - User was successfully unsubscribed from topic
Subscription Checkaction_subscription__checkChecks if the user is subscribed to a specific broadcast topic. The action calls the broadcast mo...{ "topic_id": null }success - User is subscribed to the specified topic

Testing (1)

NameSystem IDDescriptionConfigurationReturns
Testing Searchaction_testing__searchChecks if the current chat_id exists in a provided array of chat_ids. The action is used for test...{ "chat_id": [] }success - Current chat_id was found in the array and user...

Widget (1)

NameSystem IDDescriptionConfigurationReturns
Widget Calloutaction_widget__calloutSends a callout notification to the widget interface via Socket.IO. The action emits a calloutFro...{ "text": "" }ok - Callout was successfully sent to widget

Notes

  • Configuration — brief description of main parameters
  • Returns — type of value returned by the action (can be used for conditional transitions)

Related Materials

  • ActionJail module — creating and managing custom actions
  • Create a custom action
  • Use an action in Scenario Dialog
  • What are actions and how they work