widget

Call widget.update

Change a widget that already exists — 'rename that chart', 'make it look back 90 days', 'point the button at the weekly report automation' — its name, the numbers it shows and how far back it looks, its 'tell me when' threshold, a note's words, where a link goes, or what a button presses or a switch turns. Only the parts you pass change. What kind of widget it is cannot change: that is a remove and an add. The change shows wherever the widget is placed. Not for what one placement reads — that is widget.bind; not for how long it stays up — that is widget.set_expiry.

Every result names the workspace it ran in. Say which workspace the answer is about. When the account has more than one workspace and none is selected, this tool refuses with workspace_ambiguous and lists the choices — offer them, never pick one.

post/api/v1/tools/widget.update

Request

  • Base URL: https://app.goosybear.ai
  • URL: https://app.goosybear.ai/api/v1/tools/widget.update
  • Auth: HTTP bearer

Headers

x-request-idstring

Your own id for this request, echoed back and recorded on the audit trail. 1–128 characters from A–Z a–z 0–9 . _ : -, starting with a letter or digit; anything else is replaced by a generated id.

Request body

widget_idstring required

The widget's id, from widget.list. Never an id you did not read.

titlestring

A new name for it.

metric_keysstring[]

Which numbers it shows. Required on chart, table, kpi and monitor; omitted on every other kind.

grain'hour' | 'day' | 'week' | 'month' | 'quarter' | 'year' | 'lifetime'

How the numbers are bucketed. Use 'day' for a chart unless they asked for weeks or months.

window_periodsinteger

How far back it looks, counted in grain periods. 'the last 28 days' with grain=day is 28.

compare'none' | 'previous_period' | 'same_period_last_year'

What it compares against. 'previous_period' is the usual answer; 'none' shows a bare number.

link_target_kind'page' | 'site' | 'board' | 'data_table'

For a link: what it opens — a site, a page, a board (or project), or a Data table. Required for that kind.

link_target_idstring

For a link: the id of the thing it opens, read from a tool that listed it — a link to an id that does not resolve is a dead widget.

note_bodystring

For a note: what it says, in their words where you have them. Markdown renders. Required for that kind.

site_idstring uuid

For site_* numbers only: narrow it to one of their sites, by its id from page.list — never an invented id. Add page_path for one page of it.

page_pathstring

For site_* numbers only: narrow it to one page by its path, like /pricing — that path on every site unless site_id is also given.

labelstring

For a button or a switch: the words on it.

press_toolstring

For a button that presses a tool: the tool's name, like 'briefing.regenerate'. Pressing it runs that tool behind the tool's own approval.

press_automation_idstring uuid

For a button that starts an automation: its id, read from a tool that listed it.

switch_automation_idstring uuid

For a switch that turns an automation on and off: its id, read from a tool that listed it.

switch_data_table_idstring uuid

For a switch on one yes/no cell: the Data table's id. Pass switch_row_id and switch_column with it.

switch_row_idstring uuid

For a switch on one yes/no cell: the row's id.

switch_columnstring

For a switch on one yes/no cell: the column's key.

workspacestring

Which workspace to run in — its slug. Omit to use your default. With more than one reachable workspace and no default, the call is refused and the choices are listed.

Response

The call was admitted and dispatched. ok says whether the tool succeeded — a refusal the tool itself produced is still a 200, exactly as it is a successful JSON-RPC result over MCP.

OR

Changes

No recorded changes to this operation across all 4 revisions of this API.