Share a widget by link
well_share_widgetFreeze ONE widget's figures and return a link that opens it on its own web page for someone who cannot sign in to Well: an accountant, an investor, a bank, a colleague outside the workspace.
Use it when the person asks to send, forward, share or give a link to a figure or table already on screen ("send this cash position to my accountant", "give my bank something to forward"), whether or not they say "link". The figure is already drawn, so this is the whole job: call this tool straight away, with no read of the data first and no question back. For a saved BOARD of several blocks use well_share_canvas instead: a board link freezes every block together. Do not call it when the person only asks about a figure ("is that more than last month?"): nobody asked to send it. To give a link already sent newer figures, use well_refresh_share_link, not this tool: this one makes a new link.
HOW: the widget the person is looking at was drawn by one earlier tool call, visible earlier in this conversation. Call no other tool first, not even to re-read the figures. Pass tool_name (the tool that drew the widget) and arguments (the arguments of that earlier call, copied exactly: the same keys, the same values, nothing added, nothing dropped, no default filled in). Well runs that tool again as the caller and freezes what it returns, on a one-tile board kept with the workspace's boards; the same widget shared again uses the same board. A widget whose tool acted on the workspace (a document, an invoice, an email draft, a company or person as written) is never run again: Well freezes the result that call returned, which it keeps for one day for the person who drew it, in the conversation it was drawn in. Share it from that conversation; another person, another conversation or other arguments find nothing and are refused with refused_reason: "not_kept". This tool has no field for figures. Some widgets (a cash position, burn, runway, cash forecast, cash flow bridge, cost structure, monthly pivot, MRR or category trend card) take the figures themselves as their arguments, because the figures were computed before the card was drawn: Well re-checks those figures and does not measure them again. For those, arguments carries the figures, so copy them exactly as the card was drawn and never retype, round, estimate or recompute one.
A widget a reader can read can be shared: a figure, a chart, a table, a list, a document, an invoice, an email draft, a record as written. Refused, each with a refused_reason: a board (use well_share_canvas); the supplier quote comparison, whose own url is a live page for members (give that instead); and a widget that holds nothing for a reader: one that only asks the person something or offers an action (a picker, a choice card, a setup form, next steps, a connect or deploy card), the status of an upload or a connector call, or a removal. Say it cannot be shared by link and why; never offer a link anyway.
WHAT THE READER SEES: the widget exactly as the person sees it, private data included (names, salary lines, amounts), at the moment of sharing, with a date: the date its figures were measured when the result states it, otherwise the date the link was made. Never tell the person the figures were measured at that moment. It does not follow the data afterwards. The page is read-only: the reader can change nothing and decide nothing on it.
THE LIFETIME: the link has no expiry. It opens as often as the reader likes until the person stops it with well_revoke_share_links, and a refresh does not change that. When the person wants the link to stop at a date, say it opens until they stop it, and offer to stop it when they ask.
Give the link to the person who asked in the same reply, with: that it opens until they stop it, that anyone holding the link can read those figures, private data included, and that you can stop it at any time with well_revoke_share_links or give it newer figures with well_refresh_share_link. Do not repeat the figures as if they were the link's content.
When the token authorizes one workspace, call this directly — no workspace call is needed first. When it authorizes several, this read will not guess which one you mean: pass workspace_id on the call.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| arguments | Yes | The arguments of that earlier call, copied exactly: no field added, none dropped, no default filled in. Never figures typed by hand. | |
| tool_name | Yes | The tool that drew the widget, for example well_render_cash_position. | |
| workspace_id | No | Target workspace. Omit when the token authorizes one workspace. Required when it authorizes several — a write lands in exactly one workspace and this call would not say which. | |
| conversation_id | No | The conversation id returned by the previous Well result, in its meta under well/conversation_id, in its structuredContent, or in its JSON text block. Pass it back on every call in the same conversation, including a call a card makes, so the chosen workspace and the earlier answers still apply. It decides the conversation on its own: nothing the host states about the session replaces it. Omit it only on the first call of a conversation. | |
| idempotency_key | No | Optional client-supplied key. A retried write with the same key returns the original result instead of re-applying the operation. | |
| workspace_scope | No | Restrict this call to the family: the token's primary workspace plus the company workspaces under it that you are a member of. Unrelated authorized workspaces drop out of the read; row reads merge across the family, while a per-workspace figure still reports exactly one workspace. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | The link to give the person who asked. Later, well_list_share_links gives it back to them only. | |
| name | No | ||
| error | No | ||
| success | Yes | ||
| expires_at | No | Null: the link opens until it is stopped. | |
| computed_by | No | "caller" when the figures were computed before the card was drawn and Well only re-checked them, "server" when Well measured them. | |
| resolved_at | No | When the link was made. For a widget with figures computed beforehand, this is not when they were measured. | |
| share_link_id | No | Names this link for well_refresh_share_link and well_revoke_share_links. Not something to give the reader. | |
| canvas_view_id | No | The one-tile board the link was taken from. | |
| refused_reason | No | ||
| conversation_id | No | The conversation this result belongs to. Pass it back as the conversation_id argument on every later Well call in the same conversation. | |
| newly_connected | No | Tools that connected to this workspace since the last result and that no session was told about yet, oldest first. Present only when at least one tool is new. The connected-line rule says when to tell an entry; when it does, one line per entry, in the person's language: "<name> is connected.". Never fold several entries into one sentence. Each entry comes back once, on one result only: never repeat its line later. | |
| resolved_workspace | No | The workspace that answered, when the caller named none and the token authorizes several. | |
| conversation_id_note | No | Present only when the server opened a fresh lane, stating that no choice recorded earlier was read. | |
| conversation_id_source | No | Where the conversation id came from: the host's own request meta, the caller's argument, or a fresh lane the server opened. |