Skip to main content
Glama

WebRun Browser Automation

Update workflow

update_workflow
DestructiveIdempotent

Update an existing workflow. Supply workflowId plus only the fields to change: prompt, trigger, schedule, run settings, variables, presentation. Object and array fields are replaced whole; pass null to clear an optional field. Renaming via title keeps the slug stable. The stored schedule stays a saved setting — scheduled agents already deployed from this workflow keep their own timing. promptTemplate follows the same Goal / Ground rules / Stages / Output runbook contract as create_workflow (see that field's description). memoryContract is the exception to whole-replace: supplying its three fields updates them while platform tracking details are preserved.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
flowNoDashboard flow diagram: { trigger: {kind, phrase}, steps: [{ primary: {label, domain}, verb }] }.
modelNoModel profile key. Omit for the account default.
proxyNoProxy for runs. {source:"WebRun", country?} or {source:"custom", type:"http"|"socks", host, port, username?, password?}. Custom passwords are encrypted at rest and never returned. Social/messaging workflows (WhatsApp, Telegram, Instagram, Facebook, X, LinkedIn, TikTok): set country to the country the user is in right now — recommend it and confirm the country with them first; a mismatch is the usual cause of refused logins and sessions that log out repeatedly, and a scheduled workflow re-hits it every run, so keep the country stable once set.
titleNoWorkflow title (shown on the dashboard).
memoryNoThe agent's private notebook: shown to it at the start of every run, updated automatically after each run. Seed it ONLY with durable facts the next run must already know — the exact description of a target item (e.g. the specific picture to match), user preferences, known starting state — one short line per fact. Do NOT put task steps here (promptTemplate) or tracking rules here (memoryContract). Most workflows need no seed at all: the agent builds its own notebook as it runs.
skillsNoWorkflow-scoped skill entries (dashboard shape).
triggerNoHow the workflow is meant to be invoked (informational — see notes). Defaults to {type:'manual', source:'manual'}.
listTypeNoAdvanced — defaults automatically ('monitor' when memoryContract is supplied); leave unset.
scheduleNoSaved schedule setting. NOTE: record-only — the workflow does NOT run on a timer until deployed as a scheduled agent (dashboard or Telegram bot).
timezoneNoIANA timezone for runs of this workflow (e.g. "America/New_York"). Leave unset to follow the proxy country.
departmentNoFree-text department label (e.g. "inventory").
outputTypeNoOutput contract: 'text' (default), 'structured' (JSON matching outputSchema), 'structured_csv' (rows for the outputSchema column names).
workflowIdYes24-hex id of the workflow to update (from list_workflows or create_workflow). Required — the title property here is the NEW title for renames, never an identifier.
destinationNoResult destination chip: { type, sub, description }. Types seen: 'custom-api', 'slack', 'sheets', 'email', 'messaging', 'telegram', 'crm'.
startingUrlNoPage Chrome opens at the start of each run. Omit to let the prompt decide.
useCaseTagsNoCategorisation tags.
fileDeferredNoDashboard flag: file selection deferred to run time.
outputSchemaNoJSON Schema object (outputType "structured") or array of column-name strings (outputType "structured_csv").
reachOutModeNoProactive-chat policy for runs: 'off', 'guardrail_only', or 'full'. Omit (or pass null) to inherit the account default (MCP-initiated runs treat inherit as 'off').
wizardPresetNoDashboard wizard preset: { technology, useCases[], destination, destinationSub }.
environmentIdNoMove the workflow to a different environment you own. Refused while that would leave attached files or scheduled agents behind: pass requiredFiles (files in the new environment, or []) in the same update, and remove its scheduled agents first.
memoryEnabledNoPersist per-workflow agent memory across runs (default true).
publicDraftIdNoDashboard public-draft correlation id.
requiredFilesNoFiles attached to every run (downloaded before the agent starts). Each fileId must already be in the workflow's own environment (GET /environments/:id/files) — a workflow only uses files from its own environment. originalName and size are filled from that catalog.
roiHourlyRateNoHourly rate for the ROI card.
triggerPhraseNoNatural-language phrase that invokes this workflow in chat.
memoryContractNoHow this workflow should behave and what it must remember between runs. REQUIRED whenever the task handles each thing once — new messages, forward once, skip anything already done. Write all three fields in plain English, addressed to the agent; the platform wires the tracking itself. Never write any of this into the prompt: the prompt says what to do, this says how to do it consistently. To explicitly disable tracking for a task that looks like it needs it, pass {mode:'none'}.
policyOptedOutNoOpt this workflow out of the environment's default policy.
promptTemplateNoThe task the browser agent runs, written as a BROWSING RUNBOOK. Structure it as: `Goal:` — one sentence naming the outcome. `Ground rules (every stage, every turn):` — bullet invariants when the task needs them, e.g. work one item at a time — never batch; only record a figure you can read on screen this turn — if it is not shown record it as "not stated", never estimate; keep a running tally and restate it every turn ("captured C items · written R rows"). Then `Stage N — <Site name> (<https://url>)` — one section per website or phase, listing the concrete steps to take in the browser (open/navigate, click, read, capture, compare, flag) in the order a person would do them, each stage ending with `Done when: <verifiable completion condition>`. Finish with `Output —` stating exactly what to produce or deliver once the final tally is met, including what to say when there is no data (never fabricate a row). When a stage delivers per-recipient (message/email each customer), state the MATCHING RULE in that stage — the identifier shared by the source record and the destination recipient (e.g. the customer name exactly as written in the source, matched against the contact name) — and the no-match branch: skip it and report it, never deliver to a similarly-named near-match. Write the user's CONCRETE values (group names, URLs, numbers) directly into the text; use {{variables}} ONLY when the user explicitly wants a reusable template whose inputs change per run. A short single-site task can be just a Goal plus its steps. PURE TASK ONLY — never write memory bookkeeping into the prompt (no "check memory", "record in memory", "store in memory" steps): tracking is authored in memoryContract and WebRun applies it to every run automatically.
refineMessagesNoDashboard builder refinement thread rows: [{ role, content }].
variableValuesNoONLY for explicitly dynamic workflows: default values for {{variables}}, keyed by variable name. NOTE: applied only when triggering via MCP trigger_workflow (merged under caller-supplied variables); REST /trigger and bot triggers ignore this field.
compatibleToolsNoSites/tools the workflow uses: [{ name, loginUrl, domain, role }].
conciergeNotifyNoWhere the concierge announces results (e.g. 'Telegram', 'Slack', 'WhatsApp', 'Microsoft Teams', 'concierge').
workListEnabledNoAdvanced — set automatically when memoryContract is supplied; leave unset.
deployedPolicyIdNoPolicy id to run under (must be owned by you).
orchestrateFirstNoDiscovery mode: one run gathers the WHOLE work list up front, later runs claim one item each.
shortDescriptionNoOne-line summary shown in workflow lists.
roiMinutesPerTaskNoMinutes saved per run (dashboard ROI card).
templateVariablesNoONLY for explicitly dynamic workflows (the user asked for a reusable template): metadata for the {{variables}} used in promptTemplate (drives the dashboard fill-in UI). Omit entirely when the prompt carries concrete values.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
slugNo
notesNoCaveats to relay (record-only schedule, linked scheduled agents, prompt-structure advice)
titleNo
changesYesHuman-readable field: old → new summaries of what was applied (empty when everything supplied matched the current values)
successYes
workflowIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • changedInput schema / properties / environmentId / description
      Previous value: -"Move the workflow to a different environment you own."New value: +"Move the workflow to a different environment you own. Refused while that would leave attached files or scheduled agents behind: pass requiredFiles (files in the new environment, or []) in the same update, and remove its scheduled agents first."
    • changedInput schema / properties / requiredFiles / description
      Previous value: -"Per-run file attachments. Each row may name its own environmentId; ownership is enforced per-file at dispatch."New value: +"Files attached to every run (downloaded before the agent starts). Each fileId must already be in the workflow's own environment (GET /environments/:id/files) — a workflow only uses files from its own environment. originalName and size are filled from that catalog."
    • changedInput schema / properties / requiredFiles / items / properties / environmentId / description
      Previous value: -"24-hex environment id the file lives in."New value: +"Optional. If given, must be the workflow's own environment (24-hex)."
  2. Changed1 schema field changed
    • changedInput schema / properties / timezone / description
      Previous value: -"IANA timezone for runs of this workflow (e.g. \"America/New_York\")."New value: +"IANA timezone for runs of this workflow (e.g. \"America/New_York\"). Leave unset to follow the proxy country."
  3. Changed1 schema field changed
    • changedInput schema / properties / proxy / description
      Previous value: -"Proxy for runs. {source:\"WebRun\", country?} or {source:\"custom\", type:\"http\"|\"socks\", host, port, username?, password?}. Custom passwords are encrypted at rest and never returned."New value: +"Proxy for runs. {source:\"WebRun\", country?} or {source:\"custom\", type:\"http\"|\"socks\", host, port, username?, password?}. Custom passwords are encrypted at rest and never returned. Social/messaging workflows (WhatsApp, Telegram, Instagram, Facebook, X, LinkedIn, TikTok): set country to the country the user is in right now — recommend it and confirm the country with them first; a mismatch is the usual cause of refused logins and sessions that log out repeatedly, and a scheduled workflow re-hits it every run, so keep the country stable once set."
  4. Changed5 schema fields changed
    • changedInput schema / properties / listType / description
      Previous value: -"Work-list traversal policy: 'static' (one sweep), 'dynamic' (list refreshes each cycle), 'monitor' (persistent parents + consume-once children)."New value: +"Advanced — defaults automatically ('monitor' when memoryContract is supplied); leave unset."
    • changedInput schema / properties / memoryContract / description
      Previous value: -"Tracking policy — AUTHOR THIS whenever the task must remember what it already handled (forward once, skip seen items, only new messages): { mode: 'dedupe', key: 'what uniquely identifies one handled item (e.g. group + sender + time + first words)', emit: 'the exact ledger line to record per handled item' }. WebRun injects it into the agent's memory on every run (check-before-act + record-after) — so NEVER restate these steps in promptTemplate. For watch-lists, ALSO set workListEnabled + listType 'monitor'. mode 'none' = no tracking."New value: +"How this workflow should behave and what it must remember between runs. REQUIRED whenever the task handles each thing once — new messages, forward once, skip anything already done. Write all three fields in plain English, addressed to the agent; the platform wires the tracking itself. Never write any of this into the prompt: the prompt says what to do, this says how to do it consistently. To explicitly disable tracking for a task that looks like it needs it, pass {mode:'none'}."
    • addedInput schema / properties / memoryContract / properties
      Added value: +{
      +  "groundRules": {
      +    "description": "Standing rules the agent follows on every turn of every run: what it must never do, what counts as proof a step actually succeeded, what to do when something looks ambiguous, and any pacing or volume limits. Short bullets.",
      +    "maxLength": 1500,
      +    "type": "string"
      +  },
      +  "itemIdentity": {
      +    "description": "What tells one item apart from another, and stays the same the next time the agent sees it. Use only details visible on screen — for example where it came from, who it is from, when it appeared, and its opening words — and say how to write it the same way every time.",
      +    "maxLength": 300,
      +    "type": "string"
      +  },
      +  "memoryInstruction": {
      +    "description": "When a single item counts as finished, and what happens to everything else. State plainly what must be true before an item is considered done, what to do when the agent cannot tell whether a past item was done, and what happens to items left over at the end of a run.",
      +    "maxLength": 1500,
      +    "type": "string"
      +  }
      +}
    • changedInput schema / properties / promptTemplate / description
      Previous value: -"The task the browser agent runs, written as a BROWSING RUNBOOK. Structure it as: `Goal:` — one sentence naming the outcome. `Ground rules (every stage, every turn):` — bullet invariants when the task needs them, e.g. work one item at a time — never batch; only record a figure you can read on screen this turn — if it is not shown record it as \"not stated\", never estimate; keep a running tally and restate it every turn (\"captured C items · written R rows\"). Then `Stage N — <Site name> (<https://url>)` — one section per website or phase, listing the concrete steps to take in the browser (open/navigate, click, read, capture, compare, flag) in the order a person would do them, each stage ending with `Done when: <verifiable completion condition>`. Finish with `Output —` stating exactly what to produce or deliver once the final tally is met, including what to say when there is no data (never fabricate a row). When a stage delivers per-recipient (message/email each customer), state the MATCHING RULE in that stage — the identifier shared by the source record and the destination recipient (e.g. the customer name exactly as written in the source, matched against the contact name) — and the no-match branch: skip it and report it, never deliver to a similarly-named near-match. Write the user's CONCRETE values (group names, URLs, numbers) directly into the text; use {{variables}} ONLY when the user explicitly wants a reusable template whose inputs change per run. A short single-site task can be just a Goal plus its steps. PURE TASK ONLY — never write memory bookkeeping into the prompt (no \"check memory\", \"record in memory\", \"store in memory\" steps): tracking is authored in memoryContract (and the job-list flags) and WebRun injects it into every run automatically."New value: +"The task the browser agent runs, written as a BROWSING RUNBOOK. Structure it as: `Goal:` — one sentence naming the outcome. `Ground rules (every stage, every turn):` — bullet invariants when the task needs them, e.g. work one item at a time — never batch; only record a figure you can read on screen this turn — if it is not shown record it as \"not stated\", never estimate; keep a running tally and restate it every turn (\"captured C items · written R rows\"). Then `Stage N — <Site name> (<https://url>)` — one section per website or phase, listing the concrete steps to take in the browser (open/navigate, click, read, capture, compare, flag) in the order a person would do them, each stage ending with `Done when: <verifiable completion condition>`. Finish with `Output —` stating exactly what to produce or deliver once the final tally is met, including what to say when there is no data (never fabricate a row). When a stage delivers per-recipient (message/email each customer), state the MATCHING RULE in that stage — the identifier shared by the source record and the destination recipient (e.g. the customer name exactly as written in the source, matched against the contact name) — and the no-match branch: skip it and report it, never deliver to a similarly-named near-match. Write the user's CONCRETE values (group names, URLs, numbers) directly into the text; use {{variables}} ONLY when the user explicitly wants a reusable template whose inputs change per run. A short single-site task can be just a Goal plus its steps. PURE TASK ONLY — never write memory bookkeeping into the prompt (no \"check memory\", \"record in memory\", \"store in memory\" steps): tracking is authored in memoryContract and WebRun applies it to every run automatically."
    • changedInput schema / properties / workListEnabled / description
      Previous value: -"Work-list mode: the agent works a page list one item per run, reporting each back. SET THIS (with listType 'monitor') for watch-and-handle-once tasks — 'forward each new message', 'reply to new comments' — the platform then tracks handled items itself."New value: +"Advanced — set automatically when memoryContract is supplied; leave unset."
  5. Changed1 schema field changed
    • changedInput schema / properties / promptTemplate / description
      Previous value: -"The task the browser agent runs, written as a BROWSING RUNBOOK. Structure it as: `Goal:` — one sentence naming the outcome. `Ground rules (every stage, every turn):` — bullet invariants when the task needs them, e.g. work one item at a time — never batch; only record a figure you can read on screen this turn — if it is not shown record it as \"not stated\", never estimate; keep a running tally and restate it every turn (\"captured C items · written R rows\"). Then `Stage N — <Site name> (<https://url>)` — one section per website or phase, listing the concrete steps to take in the browser (open/navigate, click, read, capture, compare, flag) in the order a person would do them, each stage ending with `Done when: <verifiable completion condition>`. Finish with `Output —` stating exactly what to produce or deliver once the final tally is met, including what to say when there is no data (never fabricate a row). Write the user's CONCRETE values (group names, URLs, numbers) directly into the text; use {{variables}} ONLY when the user explicitly wants a reusable template whose inputs change per run. A short single-site task can be just a Goal plus its steps. PURE TASK ONLY — never write memory bookkeeping into the prompt (no \"check memory\", \"record in memory\", \"store in memory\" steps): tracking is authored in memoryContract (and the job-list flags) and WebRun injects it into every run automatically."New value: +"The task the browser agent runs, written as a BROWSING RUNBOOK. Structure it as: `Goal:` — one sentence naming the outcome. `Ground rules (every stage, every turn):` — bullet invariants when the task needs them, e.g. work one item at a time — never batch; only record a figure you can read on screen this turn — if it is not shown record it as \"not stated\", never estimate; keep a running tally and restate it every turn (\"captured C items · written R rows\"). Then `Stage N — <Site name> (<https://url>)` — one section per website or phase, listing the concrete steps to take in the browser (open/navigate, click, read, capture, compare, flag) in the order a person would do them, each stage ending with `Done when: <verifiable completion condition>`. Finish with `Output —` stating exactly what to produce or deliver once the final tally is met, including what to say when there is no data (never fabricate a row). When a stage delivers per-recipient (message/email each customer), state the MATCHING RULE in that stage — the identifier shared by the source record and the destination recipient (e.g. the customer name exactly as written in the source, matched against the contact name) — and the no-match branch: skip it and report it, never deliver to a similarly-named near-match. Write the user's CONCRETE values (group names, URLs, numbers) directly into the text; use {{variables}} ONLY when the user explicitly wants a reusable template whose inputs change per run. A short single-site task can be just a Goal plus its steps. PURE TASK ONLY — never write memory bookkeeping into the prompt (no \"check memory\", \"record in memory\", \"store in memory\" steps): tracking is authored in memoryContract (and the job-list flags) and WebRun injects it into every run automatically."
  6. Changed6 schema fields changed
    • changedInput schema / properties / memory / description
      Previous value: -"Seed content for the workflow's long-term memory."New value: +"The agent's private notebook: shown to it at the start of every run, updated automatically after each run. Seed it ONLY with durable facts the next run must already know — the exact description of a target item (e.g. the specific picture to match), user preferences, known starting state — one short line per fact. Do NOT put task steps here (promptTemplate) or tracking rules here (memoryContract). Most workflows need no seed at all: the agent builds its own notebook as it runs."
    • changedInput schema / properties / memoryContract / description
      Previous value: -"Memory policy channel (NEVER folded into promptTemplate): { mode: 'none'|'dedupe', key, emit, listEngine{…} }."New value: +"Tracking policy — AUTHOR THIS whenever the task must remember what it already handled (forward once, skip seen items, only new messages): { mode: 'dedupe', key: 'what uniquely identifies one handled item (e.g. group + sender + time + first words)', emit: 'the exact ledger line to record per handled item' }. WebRun injects it into the agent's memory on every run (check-before-act + record-after) — so NEVER restate these steps in promptTemplate. For watch-lists, ALSO set workListEnabled + listType 'monitor'. mode 'none' = no tracking."
    • changedInput schema / properties / promptTemplate / description
      Previous value: -"The task the browser agent runs, written as a BROWSING RUNBOOK. Structure it as: `Goal:` — one sentence naming the outcome. `Ground rules (every stage, every turn):` — bullet invariants when the task needs them, e.g. work one item at a time — never batch; only record a figure you can read on screen this turn — if it is not shown record it as \"not stated\", never estimate; keep a running tally and restate it every turn (\"captured C items · written R rows\"). Then `Stage N — <Site name> (<https://url>)` — one section per website or phase, listing the concrete steps to take in the browser (open/navigate, click, read, capture, compare, flag) in the order a person would do them, each stage ending with `Done when: <verifiable completion condition>`. Finish with `Output —` stating exactly what to produce or deliver once the final tally is met, including what to say when there is no data (never fabricate a row). Use {{variables}} for per-run values. A short single-site task can be just a Goal plus its steps. PURE TASK ONLY — never put memory/dedup instructions here; those belong in memoryContract (the policy channel)."New value: +"The task the browser agent runs, written as a BROWSING RUNBOOK. Structure it as: `Goal:` — one sentence naming the outcome. `Ground rules (every stage, every turn):` — bullet invariants when the task needs them, e.g. work one item at a time — never batch; only record a figure you can read on screen this turn — if it is not shown record it as \"not stated\", never estimate; keep a running tally and restate it every turn (\"captured C items · written R rows\"). Then `Stage N — <Site name> (<https://url>)` — one section per website or phase, listing the concrete steps to take in the browser (open/navigate, click, read, capture, compare, flag) in the order a person would do them, each stage ending with `Done when: <verifiable completion condition>`. Finish with `Output —` stating exactly what to produce or deliver once the final tally is met, including what to say when there is no data (never fabricate a row). Write the user's CONCRETE values (group names, URLs, numbers) directly into the text; use {{variables}} ONLY when the user explicitly wants a reusable template whose inputs change per run. A short single-site task can be just a Goal plus its steps. PURE TASK ONLY — never write memory bookkeeping into the prompt (no \"check memory\", \"record in memory\", \"store in memory\" steps): tracking is authored in memoryContract (and the job-list flags) and WebRun injects it into every run automatically."
    • changedInput schema / properties / templateVariables / description
      Previous value: -"Metadata for the {{variables}} used in promptTemplate (drives the dashboard fill-in UI)."New value: +"ONLY for explicitly dynamic workflows (the user asked for a reusable template): metadata for the {{variables}} used in promptTemplate (drives the dashboard fill-in UI). Omit entirely when the prompt carries concrete values."
    • changedInput schema / properties / variableValues / description
      Previous value: -"Default values for {{variables}}, keyed by variable name. NOTE: applied only when triggering via MCP trigger_workflow (merged under caller-supplied variables); REST /trigger and bot triggers ignore this field."New value: +"ONLY for explicitly dynamic workflows: default values for {{variables}}, keyed by variable name. NOTE: applied only when triggering via MCP trigger_workflow (merged under caller-supplied variables); REST /trigger and bot triggers ignore this field."
    • changedInput schema / properties / workListEnabled / description
      Previous value: -"Work-list mode: the agent works a page list one item per run, reporting each back."New value: +"Work-list mode: the agent works a page list one item per run, reporting each back. SET THIS (with listType 'monitor') for watch-and-handle-once tasks — 'forward each new message', 'reply to new comments' — the platform then tracks handled items itself."
  7. Added

TDQS

A4.7/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already signal destructive and idempotent behavior, and the description adds substantial context beyond that: object/array fields are replaced whole, null clears optional fields, renaming keeps the slug stable, stored schedules do not affect already-deployed scheduled agents, and memoryContract updates merge instead of replacing. No contradiction with annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a compact, front-loaded paragraph with no filler. Each sentence adds a distinct behavioral fact, and the update semantics come first. It is appropriately short for a tool with a massive schema.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a complex update tool with 39 parameters, the description covers the critical contextual traps: partial update semantics, whole-replacement, slug stability, schedule deployment behavior, memoryContract merging, and the promptTemplate contract reference. The output schema exists, so return values need not be explained.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3, but the description adds cross-cutting semantics that the per-parameter schema does not: the whole-replace rule, null-clearing behavior, schedule record-only caveat, and memoryContract's merge exception. It does not explain all 39 parameters, but the schema already carries that burden.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Description states a specific verb ('Update'), a specific resource ('existing workflow'), and the partial-update model ('Supply workflowId plus only the fields to change'). This clearly separates it from create_workflow, get_workflow, and trigger_workflow.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description gives explicit usage context: update an existing workflow by ID and send only the fields to change. It references create_workflow for the promptTemplate contract, but it does not explicitly state when to prefer get_workflow or create_workflow instead. Clear context, no exclusions, so not a 5.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources