Telegram integration

Connect a workspace to a Telegram bot so it answers Telegram messages.

A Telegram integration connects a workspace to a Telegram bot. Once connected, messages sent to the bot are answered by the workspace’s assistant. A workspace has at most one Telegram integration.

What the API exposes

GET /v1/workspaces/{workspaceId}/integrations/telegram returns a redacted status:

FieldMeaning
connectedWhether Telegram is set up. { connected: false } when not.
botUsernameThe bot’s public username.
botUserIdThe bot’s Telegram user id.
botUrlThe public deep link to the bot (https://t.me/<username>).

The bot token and webhook secret are never returned by the API — only the bot’s public identity above.

Connecting

  1. Create a bot with Telegram’s BotFather and copy its bot token.

  2. Connect it to the workspace, passing the token in the botToken field:

    PUT /v1/workspaces/{workspaceId}/integrations/telegram
    1{ "botToken": "123456789:AAExampleBotTokenFromBotFather" }

    The body has a single required field, botToken (string) — the bot token from BotFather. The token is validated during connection and is never returned.

Connecting is idempotent: because a workspace has at most one Telegram integration, calling this again replaces the existing one and re-registers the webhook — useful for rotating a bot token.

Disconnecting

DELETE /v1/workspaces/{workspaceId}/integrations/telegram disconnects the bot from the workspace.