TabGeckoDocs
Website
Documentation / RPA workflows

RPA workflows

Workflows are stored definitions. Running a workflow is a separate action with its own result and cancellation path.

Inspect and run an existing workflow

HTTP
GET /api/v1/automation/workflows
POST /api/v1/automation/workflows/{id}/run
GET /api/v1/automation/runs
POST /api/v1/automation/runs/{id}/cancel

Inspect steps and profile_ids before executing. Use runtime:control together with rpa:write for configuration or rpa:run for execution. Listing or copying stored workflows also needs secrets:read because definitions can contain decrypted values. MCP tokens cannot receive secrets:read; these tools are unavailable to them. Execution checks cookie and secret rights required by transitive subflows again before starting and between steps. Revocation cannot undo an already sent browser command. Capture the returned run information and inspect the run list for completion, failures and cancellation. Do not equate an accepted run request with a successful workflow.

Create a definition

POST /api/v1/automation/workflows requires name, steps, profile_ids, concurrency, close_after, delay_ms and schedule. Read the complete schema for each step action: the shared step structure contains many optional fields whose meaning depends on action. Prefer a small workflow with explicit target profiles.

JSON
{
  "name": "Example navigation",
  "steps": [
    {
      "action": "navigate",
      "value": "https://example.com"
    }
  ],
  "profile_ids": [
    "PROFILE_ID"
  ],
  "concurrency": 1,
  "close_after": false,
  "delay_ms": 0,
  "schedule": null
}

The schema allows at most 500 profile IDs and concurrency 1–20. These are validation limits, not a performance or subscription guarantee. A null schedule means no configured schedule. Before saving a schedule, use /api/v1/automation/schedule/preview and review time zone and next execution times.

Browser and input boundaries

Use observed selectors, the intended tab and explicit frame context. Support varies by browser engine, page type and action; not every native control, extension page or Shadow DOM operation is interchangeable. Closed shadow roots are not a general supported target. Read the actual step error and verify the changed page. Workflow cancellation does not undo completed steps.