Skip to main content

Automation action allowlist

POST /automation/sessions/:sessionId/actions accepts only the actions below; any other action name returns ACTION_NOT_ALLOWED. Navigation and interaction actions also accept params.snapshot (none, refs, full) to control how much of the page snapshot is returned; the default is refs.

captchaInspect

Detects CAPTCHA challenges on the page and in each iframe and returns candidates (including frameIndex, frameUrl, challengeId), and pre-installs CAPTCHA callback hooks; grid accepts DOM selectors for a custom image grid (root, tiles, instruction, verify, success, mode). Requires the X-Nex-Service-Context header.

Action fields: grid

captchaRefresh

Re-reads a GeeTest parameter endpoint already observed in this session; challengeUrl must be a GET request that successfully returned JSON in this session. Requires the X-Nex-Service-Context header.

Action fields: frameIndex / frameUrl / challengeId / challengeUrl

captchaApply

Fills the answer solution into the challenge returned by captchaInspect; frameIndex and frameUrl must match those from detection. For image grids (productCode GRID), clicks tiles by the indexes in solution.click; with gridProgress=true, only reads the subsequent state. Requires the X-Nex-Service-Context header.

Action fields: frameIndex / frameUrl / challengeId / solution / productCode / documentId / grid / gridProgress

navigate

Action-specific fields: url; https:// is prepended automatically when no scheme is given (http:// for localhost).

Action fields: url

reload

No action-specific fields.

Action fields: No action-specific fields

goBack

No action-specific fields.

Action fields: No action-specific fields

goForward

No action-specific fields.

Action fields: No action-specific fields

wait

Action-specific fields: target, text, time.

Action fields: target / text / time

snapshot

Action-specific fields: target, depth, boxes, snapshot; snapshot defaults to full, and passing refs returns only the element refs section.

Action fields: target / depth / boxes / snapshot

title

No action-specific fields.

Action fields: No action-specific fields

url

No action-specific fields.

Action fields: No action-specific fields

text

Action-specific fields: target.

Action fields: target

click

Action-specific fields: target, button; you can also pass x, y to click at viewport CSS pixel coordinates (not together with target; coordinates must be within the viewport), in which case clickCount and delay are available.

Action fields: target / button / x / y / clickCount / delay

doubleClick

Action-specific fields: target, button; coordinate click rules are the same as for click.

Action fields: target / button / x / y / clickCount / delay

hover

Action-specific fields: target.

Action fields: target

fill

Action-specific fields: target, value.

Action fields: target / value

type

Action-specific fields: target, text (value accepted for compatibility), delay.

Action fields: target / text / delay

selectOption

Action-specific fields: target, value, values.

Action fields: target / value / values

check

Action-specific fields: target.

Action fields: target

uncheck

Action-specific fields: target.

Action fields: target

drag

Action-specific fields: startTarget, endTarget.

Action fields: startTarget / endTarget

press

Action-specific fields: target, key.

Action fields: target / key

keyDown

Action-specific fields: key.

Action fields: key

keyUp

Action-specific fields: key.

Action fields: key

scroll

Action-specific fields: target, deltaX, deltaY.

Action fields: target / deltaX / deltaY

screenshot

Action-specific fields: type, filename, fullPage, quality, target, clip, scale; target and clip are mutually exclusive with fullPage=true, and scale is css or device. Returns conversion info between the screenshot region and viewport coordinates.

Action fields: type / filename / fullPage / quality / target / clip / scale

consoleMessages

Action-specific fields: clear.

Action fields: clear

networkRequests

Action-specific fields: clear, index.

Action fields: clear / index

dialogs

Action-specific fields: id, accept, dismiss, promptText.

Action fields: id / accept / dismiss / promptText

uploadFiles

Action-specific fields: target, files.

Action fields: target / files

evaluate

Action-specific fields: code, expression; only available when the allowEvaluate policy is enabled, otherwise returns ACTION_NOT_ALLOWED.

Action fields: code / expression

runCode

Action-specific fields: code; only available when the allowRunCode policy is enabled, otherwise returns ACTION_NOT_ALLOWED.

Action fields: code

resize

Action-specific fields: width, height.

Action fields: width / height

drop

Action-specific fields: target, files, data.

Action fields: target / files / data