OFFICIAL DOCUMENTATION · adv.pbxdoc.com

Learn every action.

A searchable reference for the actions available in PBX Advanced Automation v1.0.0. Based on the current development build’s Action Library and in-app help.

New in development V41.8: nested JSON references, text merging, arithmetic and conditions with calculate. Read the Variables & Expressions guide →
150 actions
http_requestHTTP & JSONDetails

What it does and how to configure it

Target = HTTPS URL (localhost HTTP allowed). Value = JSON options: {"method":"GET","save_as":"api_response","timeout":15}. Supports POST with json, and safe headers. Responses capped at 2 MB. No redirects to untrusted hosts.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

json_parseHTTP & JSONDetails

What it does and how to configure it

Target = existing variable or JSON text. Value = destination variable name. Parses JSON into typed data.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

json_getHTTP & JSONDetails

What it does and how to configure it

Target = source variable name. Value = JSON object {"path":"data.items.0.id","save_as":"item_id"}. Select a key/index without executing code.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

json_array_to_recordsHTTP & JSONDetails

What it does and how to configure it

Target = source variable name containing an array of objects. Value = destination variable name. Validates up to 200 records for later workflow use.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

api_status_checkHTTP & JSONDetails

What it does and how to configure it

Target = response variable from http_request. Value = JSON {"status":200,"save_as":"api_ok"}. Throws if response status differs.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

switch_frameEmbedded EditorsDetails

What it does and how to configure it

Target = CSS selector of a same-origin iframe (e.g. #editor-frame). Changes logical context for V40.5 embedded-editor actions only; main-page actions remain unchanged.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

switch_main_frameEmbedded EditorsDetails

What it does and how to configure it

Reset the logical frame context to the main page. No arguments.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

wait_frame_elementEmbedded EditorsDetails

What it does and how to configure it

Target = CSS selector inside the chosen iframe (or main document). Wait until it appears.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

get_element_boundsEmbedded EditorsDetails

What it does and how to configure it

Target = CSS selector in selected frame; Value = output variable name, default element_bounds. Stores JSON rect in viewport CSS pixels.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

scroll_into_viewEmbedded EditorsDetails

What it does and how to configure it

Target = CSS selector in selected frame. Scrolls target into view safely.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

drag_dropEmbedded EditorsDetails

What it does and how to configure it

Target = source CSS selector; Value = destination CSS selector. Dispatches HTML5 drag events with DataTransfer in the same document; may not work for pointer-only canvas editors.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

validate_fileFiles & RecordsDetails

What it does and how to configure it

Target = path or ${document_file}. Value = optional JSON: {"extensions":[".pdf"],"max_mb":20}. Checks existence, extension and size without a browser.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

download_fileFiles & RecordsDetails

What it does and how to configure it

Target = HTTPS URL of authorized test document. Value = output filename (basename only). Downloads to private app data/documents, max 20 MB. Stores downloaded_file variable.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

upload_documentFiles & RecordsDetails

What it does and how to configure it

Target = CSS selector of input[type=file]. Value = path or ${document_file}; never reads file content into logs. Uses native CDP DOM.setFileInputFiles.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

wait_upload_completeFiles & RecordsDetails

What it does and how to configure it

Target = CSS selector for a completed upload indicator. Value = optional expected text. Waits until element is visible (and text matches).

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

request_inputUser InputsDetails

What it does and how to configure it

Target = variable name. Value = JSON definition, e.g. {"type":"email","label":"Account email","description":"Enter the email for your account","required":true,"remember":true}. Types: text,password,multiline,file,files,int,decimal,email,url,select,checkbox,records. The user sees a form before execution, then refer to ${variable_name} in later actions.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

open_browserBrowser & TabsDetails

What it does and how to configure it

This action is available in the Script Editor. Inspect its Target and Value fields and test it on a controlled page before using it in production. The current in-app help does not specify a detailed argument contract.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

close_browserBrowser & TabsDetails

What it does and how to configure it

This action is available in the Script Editor. Inspect its Target and Value fields and test it on a controlled page before using it in production. The current in-app help does not specify a detailed argument contract.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

remove_elementWeb ElementsDetails

What it does and how to configure it

Remove the first element matching a CSS selector from the current page DOM. Temporary until reload; fails if missing.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

remove_popupsWeb ElementsDetails

What it does and how to configure it

Remove common page popup/overlay elements without clicking buttons. Optional Target: comma-separated CSS selectors. Protected login, captcha and payment dialogs are skipped. Reports count removed.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

smart_clickMouse & DesktopDetails

What it does and how to configure it

Unified click: choose web selector, webpage viewport X,Y, or desktop screen X,Y. CDP, JS or PyAutoGUI per action.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

element_rectWeb ElementsDetails

What it does and how to configure it

Get CSS element bounding rectangle (viewport pixels) and log it.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

element_centerWeb ElementsDetails

What it does and how to configure it

Get element center point and log it.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

element_textWeb ElementsDetails

What it does and how to configure it

Read element text and log it.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

element_attributeWeb ElementsDetails

What it does and how to configure it

Selector in Target; attribute name in Value.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

element_countWeb ElementsDetails

What it does and how to configure it

Count elements matching CSS selector.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

wait_textWait & ValidateDetails

What it does and how to configure it

Wait until element text contains Value.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

wait_timerWait & ValidateDetails

What it does and how to configure it

Wait for countdown in element to reach 00:00 (Timeout controls max wait).

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

js_evalScript & DataDetails

What it does and how to configure it

Value = JavaScript expression to run on selected page.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

js_clickWeb ElementsDetails

What it does and how to configure it

Click CSS selector by native DOM JS .click().

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

pyautogui_clickMouse & DesktopDetails

What it does and how to configure it

Click a webpage element by selector or desktop coordinates using PyAutoGUI.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

pyautogui_hotkeyMouse & DesktopDetails

What it does and how to configure it

Value = shortcut, for example ctrl+l.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

wait_enabledWait & ValidateDetails

What it does and how to configure it

Wait until element is enabled.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

wait_visibleWait & ValidateDetails

What it does and how to configure it

Wait until element has visible dimensions.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

wait_xpathWait & ValidateDetails

What it does and how to configure it

Target = XPath expression (without xpath:). Wait for a matching element.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

click_xpathWeb ElementsDetails

What it does and how to configure it

Target = XPath expression. Wait until clickable and click first match.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

wait_clickableWait & ValidateDetails

What it does and how to configure it

Target = CSS selector or xpath: expression. Wait until element is visible and enabled.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

click_fallbackWeb ElementsDetails

What it does and how to configure it

Target = primary CSS selector or xpath: expression; Value = fallback selectors (one per line). Click first clickable match.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

clickWeb ElementsDetails

What it does and how to configure it

CSS selector to click.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

double_clickWeb ElementsDetails

What it does and how to configure it

CSS selector to double click.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

right_clickWeb ElementsDetails

What it does and how to configure it

CSS selector to right click.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

wait_selectorWait & ValidateDetails

What it does and how to configure it

CSS selector that must appear.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

wait_hiddenWait & ValidateDetails

What it does and how to configure it

CSS selector that must disappear.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

scrollWeb ElementsDetails

What it does and how to configure it

Value = vertical pixels, e.g. 650.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

scroll_toWeb ElementsDetails

What it does and how to configure it

CSS selector to scroll into view.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

typeWeb ElementsDetails

What it does and how to configure it

Target = CSS selector; Value = text to enter.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

clearWeb ElementsDetails

What it does and how to configure it

CSS selector to clear.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

focusWeb ElementsDetails

What it does and how to configure it

CSS selector to focus.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

press_keyKeyboardDetails

What it does and how to configure it

Value = Enter, Tab, Escape, etc.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

hotkeyKeyboardDetails

What it does and how to configure it

Value = ctrl+a, ctrl+c, etc.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

navigateBrowser & TabsDetails

What it does and how to configure it

Target = primary HTTP(S) URL. Arguments/Value = optional fallback URL(s), one per line. Each URL gets at least 90 seconds. Fallback runs only if the preceding URL fails. Stores navigation_url and navigation_used_fallback.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

open_new_tabBrowser & TabsDetails

What it does and how to configure it

Target = optional HTTP(S) URL; leave empty for about:blank. Creates and switches to a new PBX CDP tab.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

close_new_tabBrowser & TabsDetails

What it does and how to configure it

Close the most recently opened workflow-owned new tab and return to the previous workflow tab. Never closes a pre-existing page.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

switch_new_tabBrowser & TabsDetails

What it does and how to configure it

Wait for the newest opened tab.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

switch_tab_indexBrowser & TabsDetails

What it does and how to configure it

Value = zero-based index from current tab list.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

wait_msWait & ValidateDetails

What it does and how to configure it

Value = delay in milliseconds.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

wait_urlBrowser & TabsDetails

What it does and how to configure it

Target = expected URL substring.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

assert_textWait & ValidateDetails

What it does and how to configure it

Target = CSS selector; Value = expected text substring.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

assert_urlWait & ValidateDetails

What it does and how to configure it

Target = URL substring that must match.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

extract_textWeb ElementsDetails

What it does and how to configure it

Target = CSS selector; Value = variable name for log.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

screenshotScript & DataDetails

What it does and how to configure it

Value = PNG file name (saved to app screenshots directory).

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

close_current_tabBrowser & TabsDetails

What it does and how to configure it

Close active page; continue on remaining page.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

browser_focusBrowser & TabsDetails

What it does and how to configure it

Bring exact PBX browser window to front (Windows).

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

browser_maximizeBrowser & TabsDetails

What it does and how to configure it

This action is available in the Script Editor. Inspect its Target and Value fields and test it on a controlled page before using it in production. The current in-app help does not specify a detailed argument contract.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

browser_minimizeBrowser & TabsDetails

What it does and how to configure it

This action is available in the Script Editor. Inspect its Target and Value fields and test it on a controlled page before using it in production. The current in-app help does not specify a detailed argument contract.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

browser_restoreBrowser & TabsDetails

What it does and how to configure it

This action is available in the Script Editor. Inspect its Target and Value fields and test it on a controlled page before using it in production. The current in-app help does not specify a detailed argument contract.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

mouse_moveMouse & DesktopDetails

What it does and how to configure it

This action is available in the Script Editor. Inspect its Target and Value fields and test it on a controlled page before using it in production. The current in-app help does not specify a detailed argument contract.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

mouse_clickMouse & DesktopDetails

What it does and how to configure it

This action is available in the Script Editor. Inspect its Target and Value fields and test it on a controlled page before using it in production. The current in-app help does not specify a detailed argument contract.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

mouse_double_clickMouse & DesktopDetails

What it does and how to configure it

This action is available in the Script Editor. Inspect its Target and Value fields and test it on a controlled page before using it in production. The current in-app help does not specify a detailed argument contract.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

mouse_right_clickMouse & DesktopDetails

What it does and how to configure it

This action is available in the Script Editor. Inspect its Target and Value fields and test it on a controlled page before using it in production. The current in-app help does not specify a detailed argument contract.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

mouse_dragMouse & DesktopDetails

What it does and how to configure it

Value=startX,startY,endX,endY.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

mouse_scrollMouse & DesktopDetails

What it does and how to configure it

PyAutoGUI wheel clicks (Value=-3 scrolls down).

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

keyboard_writeKeyboardDetails

What it does and how to configure it

This action is available in the Script Editor. Inspect its Target and Value fields and test it on a controlled page before using it in production. The current in-app help does not specify a detailed argument contract.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

keyboard_pressKeyboardDetails

What it does and how to configure it

This action is available in the Script Editor. Inspect its Target and Value fields and test it on a controlled page before using it in production. The current in-app help does not specify a detailed argument contract.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

keyboard_hotkeyKeyboardDetails

What it does and how to configure it

This action is available in the Script Editor. Inspect its Target and Value fields and test it on a controlled page before using it in production. The current in-app help does not specify a detailed argument contract.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

log_messageScript & DataDetails

What it does and how to configure it

Value = text for live log.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

set_variableScript & DataDetails

What it does and how to configure it

Target = output variable name; Value = literal text, ${variable}, ${object.field}, ${array.0.field}, or an expression prefixed with =. Example: = "name: " + ${text}.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

calculateScript & DataDetails

What it does and how to configure it

Target = output variable name; Value = an expression beginning with =. Example: Target total; Value = ${price} * ${quantity}. Use quoted strings for concatenation.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

wait_page_readyBrowser & TabsDetails

What it does and how to configure it

Wait for document.readyState complete.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

extract_linksSite DiscoveryDetails

What it does and how to configure it

Target = optional CSS scope (default body). Value = variable name (default extracted_links). Collects HTTP(S), same-origin links, unique and capped at 200. No navigation or clicks.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

assert_navigationSite DiscoveryDetails

What it does and how to configure it

Target = expected URL substring. Value = optional previous URL; fail if URL has not changed when a previous URL is provided.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

manual_checkpointUser InputsDetails

What it does and how to configure it

Target = clear prompt for the user. The workflow pauses until the user confirms authorized completion of the requested step (such as login or verification). Cancel aborts safely.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

list_nextDynamic Records & ListsDetails

What it does and how to configure it

This action is available in the Script Editor. Inspect its Target and Value fields and test it on a controlled page before using it in production. The current in-app help does not specify a detailed argument contract.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

list_randomDynamic Records & ListsDetails

What it does and how to configure it

This action is available in the Script Editor. Inspect its Target and Value fields and test it on a controlled page before using it in production. The current in-app help does not specify a detailed argument contract.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

list_shuffleDynamic Records & ListsDetails

What it does and how to configure it

This action is available in the Script Editor. Inspect its Target and Value fields and test it on a controlled page before using it in production. The current in-app help does not specify a detailed argument contract.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

list_removeDynamic Records & ListsDetails

What it does and how to configure it

This action is available in the Script Editor. Inspect its Target and Value fields and test it on a controlled page before using it in production. The current in-app help does not specify a detailed argument contract.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

compare_valuesDynamic Records & ListsDetails

What it does and how to configure it

This action is available in the Script Editor. Inspect its Target and Value fields and test it on a controlled page before using it in production. The current in-app help does not specify a detailed argument contract.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

records_mark_processedDynamic Records & ListsDetails

What it does and how to configure it

This action is available in the Script Editor. Inspect its Target and Value fields and test it on a controlled page before using it in production. The current in-app help does not specify a detailed argument contract.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

records_export_remainingDynamic Records & ListsDetails

What it does and how to configure it

This action is available in the Script Editor. Inspect its Target and Value fields and test it on a controlled page before using it in production. The current in-app help does not specify a detailed argument contract.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

progress_reportDynamic Records & ListsDetails

What it does and how to configure it

This action is available in the Script Editor. Inspect its Target and Value fields and test it on a controlled page before using it in production. The current in-app help does not specify a detailed argument contract.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

runtime_for_each_recordDynamic Records & ListsDetails

What it does and how to configure it

This action is available in the Script Editor. Inspect its Target and Value fields and test it on a controlled page before using it in production. The current in-app help does not specify a detailed argument contract.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

runtime_end_for_eachDynamic Records & ListsDetails

What it does and how to configure it

This action is available in the Script Editor. Inspect its Target and Value fields and test it on a controlled page before using it in production. The current in-app help does not specify a detailed argument contract.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

csv_importSpreadsheets & TablesDetails

What it does and how to configure it

Target = local .csv file path; Value = {"save_as":"data_rows"}. Load CSV rows into a workflow variable.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

csv_exportSpreadsheets & TablesDetails

What it does and how to configure it

Target = local .csv output path; Value = {"source":"data_rows"}. Export JSON-object records.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

excel_readSpreadsheets & TablesDetails

What it does and how to configure it

Target = local .xlsx path; Value = {"sheet":"Sheet1","save_as":"data_rows"} (sheet optional).

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

excel_writeSpreadsheets & TablesDetails

What it does and how to configure it

Target = local .xlsx output path; Value = {"source":"data_rows"}.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

excel_update_cellSpreadsheets & TablesDetails

What it does and how to configure it

Target = local .xlsx path; Value = {"sheet":"Sheet1","cell":"B2","value":"Example"}.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

table_extractSpreadsheets & TablesDetails

What it does and how to configure it

Target = CSS selector for HTML table; Value = {"save_as":"table_rows"}.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

table_find_rowSpreadsheets & TablesDetails

What it does and how to configure it

Target = table CSS selector; Value = {"text":"Invoice 123","save_as":"row_index"}.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

table_get_cellSpreadsheets & TablesDetails

What it does and how to configure it

Target = table CSS selector; Value = {"row":1,"column":2,"save_as":"cell_value"}. Zero-based indexing.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

table_wait_updateSpreadsheets & TablesDetails

What it does and how to configure it

Target = table CSS selector; Value = {"text":"Completed","timeout":30}.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

wait_untilPolling & Task SafetyDetails

What it does and how to configure it

Target = CSS selector; Value = {"text":"Ready","timeout":30}. Wait for element and optional text.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

retry_untilPolling & Task SafetyDetails

What it does and how to configure it

Target = CSS selector; Value = {"text":"Ready","timeout":30}. Repeat read-only condition checks.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

poll_statusPolling & Task SafetyDetails

What it does and how to configure it

Target = HTTPS status URL; Value = {"status":200,"attempts":5,"interval":2}. Read-only GET.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

claim_taskPolling & Task SafetyDetails

What it does and how to configure it

Target = local unique task ID; Value = {}. Prevent duplicate task claims in local ledger.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

release_taskPolling & Task SafetyDetails

What it does and how to configure it

Target = claimed task ID; Value = {}. Release local task.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

complete_taskPolling & Task SafetyDetails

What it does and how to configure it

Target = claimed task ID; Value = {"receipt":"verified-receipt-id"}.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

transaction_verifyPolling & Task SafetyDetails

What it does and how to configure it

Target = task ID; Value = {"receipt":"verified-receipt-id"}. Compare stored receipt; not proof of remote delivery.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

remote_claim_taskRemote Task CoordinationDetails

What it does and how to configure it

Target = HTTPS API base URL. Value = {"task_id":"job-123","allowed_host":"api.example.org"}. Credential via PBX_TASK_API_TOKEN environment variable.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

remote_release_taskRemote Task CoordinationDetails

What it does and how to configure it

Target = HTTPS API base URL; Value = task_id and allowed_host. Remote server must confirm released state.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

remote_complete_taskRemote Task CoordinationDetails

What it does and how to configure it

Target = HTTPS API base URL; Value = task_id, allowed_host, receipt. Server must confirm completion and verified=true.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

remote_verify_transactionRemote Task CoordinationDetails

What it does and how to configure it

Target = HTTPS API base URL; Value = task_id, allowed_host, receipt. Read-only GET; requires server verified=true.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

get_element_attributeDynamic Form ControlsDetails

What it does and how to configure it

Target = CSS selector. Value = {"attribute":"aria-checked","index":0,"save_as":"state"}. Reads attribute or property.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

ensure_checkbox_stateDynamic Form ControlsDetails

What it does and how to configure it

Target = checkbox CSS selector. Value = {"state":true,"index":0}. Clicks only if required; verifies final state.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

count_elementsDynamic Form ControlsDetails

What it does and how to configure it

Target = CSS selector. Value = {"save_as":"matched_count"}.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

wait_element_count_changeDynamic Form ControlsDetails

What it does and how to configure it

Target = CSS selector. Value = {"from":1,"timeout":15,"save_as":"new_count"}.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

element_at_indexDynamic Form ControlsDetails

What it does and how to configure it

Target = CSS selector. Value = {"index":0,"save_as":"matched_html"}. Stores truncated element HTML.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

generate_time_sequenceDynamic Form ControlsDetails

What it does and how to configure it

Target = duration seconds or HH:MM:SS. Value = {"interval":300,"save_as":"slots"}. Max 200 timestamps.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

format_durationDynamic Form ControlsDetails

What it does and how to configure it

Target = seconds. Value = {"save_as":"display_time"}.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

set_input_with_eventsDynamic Form ControlsDetails

What it does and how to configure it

Target = CSS selector. Value = {"text":"hello","index":0}. Sends input/change events.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

verify_saved_stateDynamic Form ControlsDetails

What it does and how to configure it

Target = CSS selector. Value = {"attribute":"value","expected":"hello"}. Checks current DOM; does not prove remote persistence.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

function_startFunctions & LoopsDetails

What it does and how to configure it

Define a reusable named block. Target = function name; finish with function_end.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

function_endFunctions & LoopsDetails

What it does and how to configure it

End the reusable function definition. No arguments.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

function_callFunctions & LoopsDetails

What it does and how to configure it

Run a named function. Target = defined function name.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

loop_startFunctions & LoopsDetails

What it does and how to configure it

Begin a counted loop. Value = number of repeats (0–1000). Finish with loop_end.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

loop_endFunctions & LoopsDetails

What it does and how to configure it

Close the nearest loop_start block.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

for_each_recordFunctions & LoopsDetails

What it does and how to configure it

Target = record-list input variable. Execute enclosed steps once per row; use ${record.email}, ${record.password}, ${record.index}. Close with end_for_each.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

end_for_eachFunctions & LoopsDetails

What it does and how to configure it

Finish the nearest for_each_record block.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

random_intRandom & FakerDetails

What it does and how to configure it

Generate integer into variable Target. Value JSON: {"min":1,"max":100}.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

random_stringRandom & FakerDetails

What it does and how to configure it

Generate random string into Target. Value JSON: {"length":12}.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

faker_nameRandom & FakerDetails

What it does and how to configure it

Generate synthetic person name. Target = output variable.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

faker_addressRandom & FakerDetails

What it does and how to configure it

Generate synthetic address. Target = output variable.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

faker_cityRandom & FakerDetails

What it does and how to configure it

Generate synthetic city. Target = output variable.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

faker_locationRandom & FakerDetails

What it does and how to configure it

Generate synthetic location object. Target = output variable.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

faker_phoneRandom & FakerDetails

What it does and how to configure it

Generate synthetic phone number. Target = output variable.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

faker_emailRandom & FakerDetails

What it does and how to configure it

Generate synthetic test email. Target = output variable.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

faker_profileRandom & FakerDetails

What it does and how to configure it

Generate synthetic profile object. Target = output variable.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

file_read_rowFiles & RecordsDetails

What it does and how to configure it

Read a CSV/JSON/TXT record into Target variable. Value JSON: {"alias":"input","index":0}.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

file_next_rowFiles & RecordsDetails

What it does and how to configure it

Read next record into Target and advance cursor. Value JSON: {"alias":"input"}.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

file_appendFiles & RecordsDetails

What it does and how to configure it

Append record. Target = variable containing data. Value JSON: {"alias":"output"}.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

file_update_rowFiles & RecordsDetails

What it does and how to configure it

Update record. Target = variable holding fields. Value JSON: {"alias":"input","index":0}.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

file_remove_rowFiles & RecordsDetails

What it does and how to configure it

Remove a processed record (after success only). Value JSON: {"alias":"input","index":0}.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

file_createFiles & RecordsDetails

What it does and how to configure it

Create attached output file (will not overwrite). Target = output alias. Value JSON: {"alias":"output"}.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

file_uploadFiles & RecordsDetails

What it does and how to configure it

Upload attached local file via CDP. Target = CSS selector of input[type=file]; Value JSON: {"alias":"input"}.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

file_selectFiles & RecordsDetails

What it does and how to configure it

Check that a configured file alias is attached. Target = alias (e.g. input).

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

ifConditionsDetails

What it does and how to configure it

This action is available in the Script Editor. Inspect its Target and Value fields and test it on a controlled page before using it in production. The current in-app help does not specify a detailed argument contract.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

else_ifConditionsDetails

What it does and how to configure it

This action is available in the Script Editor. Inspect its Target and Value fields and test it on a controlled page before using it in production. The current in-app help does not specify a detailed argument contract.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

elseConditionsDetails

What it does and how to configure it

This action is available in the Script Editor. Inspect its Target and Value fields and test it on a controlled page before using it in production. The current in-app help does not specify a detailed argument contract.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

end_ifConditionsDetails

What it does and how to configure it

This action is available in the Script Editor. Inspect its Target and Value fields and test it on a controlled page before using it in production. The current in-app help does not specify a detailed argument contract.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

call_variableScript & DataDetails

What it does and how to configure it

This action is available in the Script Editor. Inspect its Target and Value fields and test it on a controlled page before using it in production. The current in-app help does not specify a detailed argument contract.

In Script Editor: Add this action, fill in the Target and Value / Arguments fields according to the description, save, and test in an authorized environment. Variables use ${variable_name}.

Documentation scope: The descriptions come from the application’s embedded help. They are not proof that an action works on every site. An on-page state check is not proof that a remote transaction was saved. Remote tasks require a compatible, authorized API.