🎯 System Actions Guide

Note: This guide is being translated. Some parts may still be in Russian or incomplete.

Complete description of all available actions with their parameters and results.

📋 Table of Contents

action_hub (1 actions)
- get_available_actions
event_processor (1 actions)
- process_event
scenario_processor (3 actions)
storage_hub (1 actions)
- sync_tenant_storage
telegram_bot_manager (6 actions)
tenant_hub (6 actions)

action_hub

Description: Central action hub for routing to services

get_available_actions

Description: Get all available actions with metadata

Input Parameters:

⚙️ Additional Parameters

_namespace (string) (optional) — Custom key for creating nesting in _cache. If specified, data is saved in _cache[_namespace] instead of flat cache. Used to control overwriting on repeated calls of the same action. Access via {_cache._namespace.field}. By default, data is merged directly into _cache (flat caching).

Output Parameters:

result (string) — Result: success, error
error (object) (optional) — Error structure
- code (string) — Error code
- message (string) — Error message
- details (array) (optional) — Error details (e.g. field validation errors)
response_data (object) — Dict of all available actions with metadata

Usage Example:

yaml

# In scenario
- action: "get_available_actions"
  params:
    # Parameters not required

event_processor

Description: Service for processing polling events

process_event

Description: Process polling event

Input Parameters:

data (object) — Raw event from polling

Output Parameters:

result (string) — Result: success, error
error (object) (optional) — Error structure
- code (string) — Error code
- message (string) — Error message
- details (array) (optional) — Error details

Usage Example:

yaml

# In scenario
- action: "process_event"
  params:
    data: {}

scenario_processor

Description: Service for processing events by scenarios

process_scenario_event

Description: Process event by scenarios

Input Parameters:

event_type (string, required, min length: 1) — Event type (message, callback_query, etc.)
bot_id (integer, required, min: 1) — Bot ID that received the event

Output Parameters:

result (string) — Processing result (success/error)
error (object) (optional) — Error structure
- code (string) — Error code
- message (string) — Error message
- details (array) (optional) — Error details

Usage Example:

yaml

# In scenario
- action: "process_scenario_event"
  params:
    event_type: "example"
    bot_id: 123

sync_scenarios

Description: Sync tenant scenarios: delete old → save new → reload cache

Input Parameters:

tenant_id (integer, required, min: 1) — Tenant ID for scenario sync
scenarios (array (of object)) — Array of scenarios to sync

Output Parameters:

result (string) — Sync result (success/partial_success/error)
error (object) (optional) — Error structure
- code (string) — Error code
- message (string) — Error message
- details (array) (optional) — Error details

Usage Example:

yaml

# In scenario
- action: "sync_scenarios"
  params:
    tenant_id: 123
    scenarios: []

sync_tenant_scenarios

Description: Sync tenant scenarios: parse scenarios/*.yaml + sync to database

Input Parameters:

tenant_id (integer, required, min: 1) — Tenant ID

Output Parameters:

result (string) — Result: success, error
error (object) (optional) — Error structure
- code (string) — Error code
- message (string) — Error message
- details (array) (optional) — Error details

Usage Example:

yaml

# In scenario
- action: "sync_tenant_scenarios"
  params:
    tenant_id: 123

storage_hub

Description: Service for managing tenant storage

sync_tenant_storage

Description: Sync tenant storage: parse storage/*.yaml + sync to database

Input Parameters:

tenant_id (integer, required, min: 1) — Tenant ID

Output Parameters:

result (string) — Result: success, error
error (object) (optional) — Error structure
- code (string) — Error code
- message (string) — Error message
- details (array) (optional) — Error details

Usage Example:

yaml

# In scenario
- action: "sync_tenant_storage"
  params:
    tenant_id: 123

telegram_bot_manager

Description: Service for managing Telegram bot lifecycle

get_telegram_bot_info_by_id

Description: Get Telegram bot info from database by bot_id (with caching)

Input Parameters:

bot_id (integer, required, min: 1) — Bot ID
force_refresh (boolean, optional) — Force refresh cache

⚙️ Additional Parameters

_namespace (string) (optional) — Custom key for creating nesting in _cache. If specified, data is saved in _cache[_namespace] instead of flat cache. Used to control overwriting on repeated calls of the same action. Access via {_cache._namespace.field}. By default, data is merged directly into _cache (flat caching).

Output Parameters:

result (string) — Request result
error (object) (optional) — Error structure
- code (string) — Error code
- message (string) — Error message
- details (array) (optional) — Error details
response_data (object) — Bot data from database
- bot_id (integer) — Bot ID
- telegram_bot_id (integer) — Bot ID in Telegram
- tenant_id (integer) — Tenant ID
- bot_token (string) — Bot token
- username (string) — Bot username
- first_name (string) — Bot first name
- is_active (boolean) — Whether bot is active
- bot_command (array) — Bot commands

Usage Example:

yaml

# In scenario
- action: "get_telegram_bot_info_by_id"
  params:
    bot_id: 123
    # force_refresh: boolean (optional)

get_telegram_bot_status

Description: Get Telegram bot status (polling/webhook, activity)

Input Parameters:

bot_id (integer, required, min: 1) — Bot ID

⚙️ Additional Parameters

_namespace (string) (optional) — Custom key for creating nesting in _cache. If specified, data is saved in _cache[_namespace] instead of flat cache. Used to control overwriting on repeated calls of the same action. Access via {_cache._namespace.field}. By default, data is merged directly into _cache (flat caching).

Output Parameters:

result (string) — Request result
error (object) (optional) — Error structure
- code (string) — Error code
- message (string) — Error message
- details (array) (optional) — Error details
response_data (object) — Bot status
- is_polling (boolean) — Whether polling is active
- is_webhook_active (boolean) — Whether webhook is active
- is_active (boolean) — Whether bot is active
- is_working (boolean) — Whether bot is working (polling or webhook)

Usage Example:

yaml

# In scenario
- action: "get_telegram_bot_status"
  params:
    bot_id: 123

set_telegram_bot_token

Description: Set Telegram bot token

Input Parameters:

tenant_id (integer, required, min: 1) — Tenant ID
bot_token (string|None, optional) — Bot token or null to clear

Output Parameters:

result (string) — Result: success, error
error (object) (optional) — Error structure
- code (string) — Error code
- message (string) — Error message
- details (array) (optional) — Error details

Usage Example:

yaml

# In scenario
- action: "set_telegram_bot_token"
  params:
    tenant_id: 123
    # bot_token: string|None (optional)

start_telegram_bot

Description: Start Telegram bot (polling or webhook)

Input Parameters:

bot_id (integer, required, min: 1) — Bot ID

Output Parameters:

result (string) — Result: success, error
error (object) (optional) — Error structure
- code (string) — Error code
- message (string) — Error message
- details (array) (optional) — Error details

Usage Example:

yaml

# In scenario
- action: "start_telegram_bot"
  params:
    bot_id: 123

stop_telegram_bot

Description: Stop Telegram bot

Input Parameters:

bot_id (integer, required, min: 1) — Bot ID

Output Parameters:

result (string) — Result: success, error
error (object) (optional) — Error structure
- code (string) — Error code
- message (string) — Error message
- details (array) (optional) — Error details

Usage Example:

yaml

# In scenario
- action: "stop_telegram_bot"
  params:
    bot_id: 123

sync_telegram_bot

Description: Sync Telegram bot for tenant: parse bots/telegram.yaml + create/update bot + sync commands + start

Input Parameters:

tenant_id (integer, required, min: 1) — Tenant ID

⚙️ Additional Parameters

_namespace (string) (optional) — Custom key for creating nesting in _cache. If specified, data is saved in _cache[_namespace] instead of flat cache. Used to control overwriting on repeated calls of the same action. Access via {_cache._namespace.field}. By default, data is merged directly into _cache (flat caching).

Output Parameters:

result (string) — Result: success, error, not_found
error (object) (optional) — Error structure
- code (string) — Error code
- message (string) — Error message
- details (array) (optional) — Error details
response_data (object) (optional) — Response data (bot_id, action)
- bot_id (integer) — Bot ID
- action (string) — Action performed

Usage Example:

yaml

# In scenario
- action: "sync_telegram_bot"
  params:
    tenant_id: 123

tenant_hub

Description: Orchestrator service for managing tenants. Coordinates GitHub sync, delegates parsing and sync to specialized services

get_bot_id_by_tenant_id

Description: Get bot_id by tenant_id and bot type. Database lookup, not tied to messenger type.

Input Parameters:

tenant_id (integer, required, min: 1) — Tenant ID
bot_type (string, optional) — Bot type (telegram, later whatsapp etc.). Only telegram supported for now.

⚙️ Additional Parameters

_namespace (string) (optional) — Custom key for creating nesting in _cache. If specified, data is saved in _cache[_namespace] instead of flat cache. Used to control overwriting on repeated calls of the same action. Access via {_cache._namespace.field}. By default, data is merged directly into _cache (flat caching).
_response_key (string) (optional) — Custom name for main result field (marked 🔀). If specified, main field will be saved in _cache under specified name instead of standard. Access via {_cache.{_response_key}}. Works only for actions that support renaming main field.

Output Parameters:

result (string) — Result: success, error
error (object) (optional) — Error structure (NOT_FOUND if tenant has no bot of this type)
- code (string) —
- message (string) —
response_data (object) —
- 🔀 bot_id (integer) — Bot ID in database

Note:

🔀 — field that can be renamed via _response_key parameter for convenient data access

Usage Example:

yaml

# In scenario
- action: "get_bot_id_by_tenant_id"
  params:
    tenant_id: 123
    # bot_type: string (optional)

get_tenant_status

Description: Get tenant status from cache: last update date, last error (no bot data)

Input Parameters:

tenant_id (integer, required, min: 1) — Tenant ID

⚙️ Additional Parameters

_namespace (string) (optional) — Custom key for creating nesting in _cache. If specified, data is saved in _cache[_namespace] instead of flat cache. Used to control overwriting on repeated calls of the same action. Access via {_cache._namespace.field}. By default, data is merged directly into _cache (flat caching).

Output Parameters:

result (string) — Result: success
response_data (object) — Tenant cache data
- last_updated_at (string) (optional) — Last successful update date
- last_failed_at (string) (optional) — Last failure date
- last_error (object) (optional) — Last error object (code, message, details)

Usage Example:

yaml

# In scenario
- action: "get_tenant_status"
  params:
    tenant_id: 123

get_tenants_list

Description: Get list of all tenant IDs split into public and system

Input Parameters:

⚙️ Additional Parameters

_namespace (string) (optional) — Custom key for creating nesting in _cache. If specified, data is saved in _cache[_namespace] instead of flat cache. Used to control overwriting on repeated calls of the same action. Access via {_cache._namespace.field}. By default, data is merged directly into _cache (flat caching).

Output Parameters:

result (string) — Result: success, error
error (object) (optional) — Error structure
- code (string) — Error code
- message (string) — Error message
- details (array) (optional) — Error details
response_data (object) —
- tenant_ids (array (of integer)) — Array of all tenant IDs
- public_tenant_ids (array (of integer)) — Array of public tenant IDs
- system_tenant_ids (array (of integer)) — Array of system tenant IDs
- tenant_count (integer) — Total number of tenants

Usage Example:

yaml

# In scenario
- action: "get_tenants_list"
  params:

sync_all_tenants

Description: Sync all tenants (pull from GitHub first, then sync all)

Input Parameters:

Output Parameters:

result (string) — Result: success, partial_success, error
error (object) (optional) — Error structure
- code (string) — Error code
- message (string) — Error message
- details (array) (optional) — Error details

Usage Example:

yaml

# In scenario
- action: "sync_all_tenants"
  params:

sync_tenant

Description: Sync tenant configuration with database (fetch from GitHub first, then sync)

Input Parameters:

tenant_id (integer, required, min: 1) — Tenant ID to sync

Output Parameters:

result (string) — Result: success, error, timeout, not_found
error (object) (optional) — Error structure
- code (string) — Error code
- message (string) — Error message
- details (array) (optional) — Error details

Usage Example:

yaml

# In scenario
- action: "sync_tenant"
  params:
    tenant_id: 123

update_tenant_config

Description: Update tenant config (updates DB, invalidates cache). Only updates provided fields

Input Parameters:

tenant_id (integer, required, min: 1) — Tenant ID
ai_token (string|None, optional) — AI API token for tenant (optional; if not passed - field unchanged, if null - removed)

Output Parameters:

result (string) — Result: success, error
error (object) (optional) — Error structure
- code (string) — Error code
- message (string) — Error message
- details (array) (optional) — Error details

Usage Example:

yaml

# In scenario
- action: "update_tenant_config"
  params:
    tenant_id: 123
    # ai_token: string|None (optional)

🎯 System Actions Guide ​

📋 Table of Contents ​

action_hub ​

get_available_actions ​

event_processor ​

process_event ​

scenario_processor ​

process_scenario_event ​

sync_scenarios ​

sync_tenant_scenarios ​

storage_hub ​

sync_tenant_storage ​

telegram_bot_manager ​

get_telegram_bot_info_by_id ​

get_telegram_bot_status ​

set_telegram_bot_token ​

start_telegram_bot ​

stop_telegram_bot ​

sync_telegram_bot ​

tenant_hub ​

get_bot_id_by_tenant_id ​

get_tenant_status ​

get_tenants_list ​

sync_all_tenants ​

sync_tenant ​

update_tenant_config ​

🎯 System Actions Guide

📋 Table of Contents

action_hub

get_available_actions

event_processor

process_event

scenario_processor

process_scenario_event

sync_scenarios

sync_tenant_scenarios

storage_hub

sync_tenant_storage

telegram_bot_manager

get_telegram_bot_info_by_id

get_telegram_bot_status

set_telegram_bot_token

start_telegram_bot

stop_telegram_bot

sync_telegram_bot

tenant_hub

get_bot_id_by_tenant_id

get_tenant_status

get_tenants_list

sync_all_tenants

sync_tenant

update_tenant_config