Get the general invitation link
well_get_general_invite_linkRead-only
Return the general invitation link to Well: the link a user forwards so that someone opens their OWN account on Well. It opens the WhatsApp chat with Well, and the person who uses it gets their own workspace, not the user's. Use it when the user asks for a link to invite someone to Well in general ("un lien pour que quelqu'un ouvre un compte sur Well").
It gives no access to any workspace of the user. For a link into the user's own workspace, use well_get_workspace_invite_link. When the user asks for "the invitation link" and does not say which of the two they mean, ask them before any call.
Pass language, the language of the conversation, so the greeting the link carries is in that language.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| language | No | The language of the conversation, for the greeting the link prefills. Defaults to English. | |
| workspace_id | No | Target workspace. Optional: this tool describes the token itself rather than one workspace's data, so omitting it returns the same answer. | |
| 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. | |
| 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 |
|---|---|---|---|
| error | No | ||
| success | Yes | ||
| general_link | No | The link that opens the WhatsApp chat with Well. A person who uses it gets their own workspace. Give it to the user exactly as returned. Absent when success is false. | |
| 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. |