Actions API Reference

Back to Configuration overview.

click

Click an element. Use to dismiss cookie banners, open menus, expand dropdowns.

Property	Type	Required	Description
selector	string	yes	CSS selector of the element to click
doubleClick	boolean	no	Whether to perform a double click
button	"left" | "right" | "middle"	no	Mouse button to click
modifiers	("Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift")[]	no	Modifier keys to hold during click
timeout	number	no	Timeout in milliseconds

// minimal
{
  "type": "click",
  "selector": ".my-element"
}

// with options
{
  "type": "click",
  "selector": ".my-element",
  "doubleClick": true,
  "button": "right",
  "modifiers": [
    "Control"
  ],
  "timeout": 1
}

type

Type text into an input, textarea, or contenteditable element.

Property	Type	Required	Description
selector	string	yes	CSS selector of the input element
text	string	yes	Text to type into the element
submit	boolean	no	Whether to press Enter after typing (submit form)
slowly	boolean	no	Type one character at a time for key handlers
timeout	number	no	Timeout in milliseconds

// minimal
{
  "type": "type",
  "selector": ".my-element",
  "text": "Hello world"
}

// with options
{
  "type": "type",
  "selector": ".my-element",
  "text": "Hello world",
  "submit": true,
  "slowly": true,
  "timeout": 1
}

hover

Hover over an element to trigger :hover states, show tooltips, or reveal menus.

Property	Type	Required	Description
selector	string	yes	CSS selector of the element to hover over
timeout	number	no	Timeout in milliseconds

// minimal
{
  "type": "hover",
  "selector": ".my-element"
}

// with options
{
  "type": "hover",
  "selector": ".my-element",
  "timeout": 1
}

select_option

Select one or more options in a native <select> dropdown.

Property	Type	Required	Description
selector	string	yes	CSS selector of the <select> element
values	string[]	yes	Option values to select. Supports multiple.
timeout	number	no	Timeout in milliseconds

// minimal
{
  "type": "select_option",
  "selector": ".my-element",
  "values": [
    "option-1",
    "option-2"
  ]
}

// with options
{
  "type": "select_option",
  "selector": ".my-element",
  "values": [
    "option-1",
    "option-2"
  ],
  "timeout": 1
}

press_key

Press a keyboard key or combination. Use to close modals, submit forms, etc.

Property	Type	Required	Description
key	string	yes	Key to press, e.g. "Enter", "Escape", "Control+a"

{
  "type": "press_key",
  "key": "Enter"
}

drag

Drag an element and drop it onto another.

Property	Type	Required	Description
from	string	yes	CSS selector of the element to drag
to	string	yes	CSS selector of the drop target
timeout	number	no	Timeout in milliseconds

// minimal
{
  "type": "drag",
  "from": ".draggable-item",
  "to": ".drop-zone"
}

// with options
{
  "type": "drag",
  "from": ".draggable-item",
  "to": ".drop-zone",
  "timeout": 1
}

wait

Pause execution until a condition is met.

Property	Type	Required	Description
time	number	no	Time to wait in seconds (max 30s)
text	string	no	Wait for this text to appear on the page
textGone	string	no	Wait for this text to disappear from the page

// minimal
{
  "type": "wait"
}

// with options
{
  "type": "wait",
  "time": 0.5,
  "text": "Hello world",
  "textGone": "Loading..."
}

navigate

Navigate to a different URL or go back in history.

Property	Type	Required	Description
url	string	no	URL to navigate to (absolute or relative)
back	boolean	no	Navigate back to the previous page

// minimal
{
  "type": "navigate"
}

// with options
{
  "type": "navigate",
  "url": "/dashboard",
  "back": true
}

evaluate

Run arbitrary JavaScript in the browser context. Escape hatch for DOM manipulation.

Property	Type	Required	Description
function	string	yes	JavaScript function: () => { ... } or (el) =>
selector	string	no	CSS selector of element to pass to function

// minimal
{
  "type": "evaluate",
  "function": "() => { document.querySelector(\".ad\").remove() }"
}

// with options
{
  "type": "evaluate",
  "function": "() => { document.querySelector(\".ad\").remove() }",
  "selector": ".my-element"
}

fill_form

Fill multiple form fields in one action.

Property	Type	Required	Description
fields	object[]	yes	Array of fields to fill
↳ fields[].selector	string	yes	CSS selector of the form field
↳ fields[].value	string	yes	Value to fill. Checkboxes: "true"/"false"
↳ fields[].fieldType	"textbox" | "checkbox" | "radio" | "combobox" | "slider"	yes	Type of the form field
timeout	number	no	Timeout in milliseconds per field

// minimal
{
  "type": "fill_form",
  "fields": [
    {
      "selector": "#email",
      "value": "demo@example.com",
      "fieldType": "textbox"
    }
  ]
}

// with options
{
  "type": "fill_form",
  "fields": [
    {
      "selector": "#email",
      "value": "demo@example.com",
      "fieldType": "textbox"
    }
  ],
  "timeout": 1
}

handle_dialog

Set up handler for browser dialog. Place BEFORE action that triggers dialog.

Property	Type	Required	Description
accept	boolean	yes	Whether to accept the dialog
promptText	string	no	Text to enter in case of a prompt dialog

// minimal
{
  "type": "handle_dialog",
  "accept": true
}

// with options
{
  "type": "handle_dialog",
  "accept": true,
  "promptText": "my answer"
}

file_upload

Upload one or more files through a file input element.

Property	Type	Required	Description
selector	string	yes	CSS selector of the file input element
paths	string[]	yes	File paths to upload (absolute or relative to config)

{
  "type": "file_upload",
  "selector": ".my-element",
  "paths": ["./screenshot.png"]
}

resize

Resize the browser viewport mid-flow.

Property	Type	Required	Description
width	number	yes	Viewport width in pixels
height	number	yes	Viewport height in pixels

{
  "type": "resize",
  "width": 375,
  "height": 667
}

hide

Hide elements from screenshot. Use to remove cookie banners, chat widgets, ads.

Property	Type	Required	Description
selectors	string[]	yes	CSS selectors of elements to hide (display: none)

{
  "type": "hide",
  "selectors": []
}