Skip to main content
Version: v1

Update

An event addressed to the bot

updateIdinteger<int64>required
newChatMessage object

A message visible to the bot

workspaceIdstring<flake-id>required

Workspace ID

Example: w67Y89gu
chatIdstring<string-id>required

Chat ID, unique within a workspace

Example: c56Y0kgi
messageIdstring<flake-id>required

Message ID, unique within a workspace and chat

Example: m56Y0kgi
authorstring<flake-id>required

User account ID

Example: a56Y0kgi
parentMessageIdstring<flake-id>

Message ID, unique within a workspace and chat

Example: m56Y0kgi
parentMessageAuthorstring<flake-id>

User account ID

Example: a56Y0kgi
markdownstringrequired
fileIdsstring[]
createdAtstring<date-time>required

Date and time the message was sent

Example: 2023-02-26T18:58:36.154+03:00
inviteToChat object

Bot invitation to a chat

workspaceIdstring<flake-id>required

Workspace ID

Example: w67Y89gu
chatIdstring<string-id>required

Chat ID, unique within a workspace

Example: c56Y0kgi
inviterstring<flake-id>required

User account ID

Example: a56Y0kgi
joinedToChat object
workspaceIdstring<flake-id>required

Workspace ID

Example: w67Y89gu
chatIdstring<string-id>required

Chat ID, unique within a workspace

Example: c56Y0kgi
inviterstring<flake-id>

User ID within a specific workspace

Example: a56Y0kgi
joinedstring<flake-id>[]required
leftFromChat object
workspaceIdstring<flake-id>required

Workspace ID

Example: w67Y89gu
chatIdstring<string-id>required

Chat ID, unique within a workspace

Example: c56Y0kgi
kickerstring<flake-id>

User ID within a specific workspace

Example: a56Y0kgi
leftstring<flake-id>[]required
Update
{
"updateId": 0,
"newChatMessage": {
"workspaceId": "w67Y89gu",
"chatId": "c56Y0kgi",
"messageId": "m56Y0kgi",
"author": "a56Y0kgi",
"markdown": "Reminder: the company party is today at 19:00 (bots are invited too)"
},
"inviteToChat": {
"workspaceId": "w67Y89gu",
"chatId": "c56Y0kgi",
"inviter": "a56Y0kgi"
},
"joinedToChat": {
"workspaceId": "w67Y89gu",
"chatId": "c56Y0kgi",
"inviter": "a56Y0kgi",
"joined": [
"a56Y0kgi"
]
},
"leftFromChat": {
"workspaceId": "w67Y89gu",
"chatId": "c56Y0kgi",
"kicker": "a56Y0kgi",
"left": [
"a56Y0kgi"
]
}
}