Skip to main content
POST
Create Telegram integration

Authorizations

Authorization
string
header
required

API key or session token (Bearer)

Path Parameters

projectId
string
required

Body

application/json
botToken
string
required

A Telegram bot token, in the form 123456789:AA...

Minimum string length: 1
chatId
string
required
Minimum string length: 1
threadId
number
chatLabel
string
events
object

Response

object | null

The stored integration

id
string
required
projectId
string
required
chatId
string
required

The Telegram chat, group, or channel messages are sent to.

threadId
number | null
required

Forum topic id, when the target group uses topics.

chatLabel
string | null
required

A human-readable name for the chat, shown in the UI.

botTokenConfigured
boolean
required
maskedBotToken
string
required
events
object
required
isActive
boolean | null
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required