Request a tool that is not available yet
well_request_connectorAsk Well to add ONE tool it cannot connect yet, for this workspace.
The request card's button calls this itself. Call it yourself only when the person asks for the tool in words, or picks the request option in a text reply, after well_show_connector_request named the tool. Pass the same name, and as slug the card's service_id (also when the pick text carries it as "slug"). Omit slug only for a tool the card showed with no service id.
A workspace counts once per tool: a second request reads back as "already_requested" and counts nothing. A tool that can be connected now is not requested ("connectable"): draw the connect card instead. A tool under maintenance is not requested ("under_maintenance"): say it is under maintenance. An AI app is not requested ("ai_client_connects_itself"): say it connects from its own settings. Say the outcome in one line; never promise a date.
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 |
|---|---|---|---|
| name | Yes | The tool's name as the person wrote it, e.g. "Pipedrive". At most 60 characters: letters, digits, spaces and . & ' + -. Never an address, a link, an email or a domain suffix: write "Monday", not "Monday.com". | |
| slug | No | The catalog slug, when a well_list_connectors read returned one for this tool. Omit otherwise. | |
| 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 |
|---|---|---|---|
| name | No | ||
| error | No | ||
| status | No | ||
| outcome | No | "recorded", "already_requested", "connectable" (connect it instead), "under_maintenance" (Well carries it and it is under maintenance; nothing requested), "ai_client_connects_itself" (an AI app: it connects from its own settings; nothing requested), "daily_cap_reached" or "not_recorded" (nothing stored; the person can ask again later). | |
| success | Yes | True when the workspace has the request on record: recorded now, or asked before. | |
| 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. | |
| 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. |