Update

An object of some event (update) related to the bot. Contains an identifier and one of the populated fields depending on the event type.

updateIdinteger<int64>

Update identifier, monotonically increasing. Later updates have a larger identifier

message object

Update object - message

workspaceIdstringrequired

ID of the workspace the message was sent in

Example: AIQffAsGi8

chatIdstringrequired

ID of the chat the message was sent to

Example: w:AIQffAsGi8

messageIdstringrequired

Message ID

Example: gIQffAsGi8

messageTypeMessageType (string)required

Message type - from a user or system

Possible values: [USER, SYSTEM]

Example: USER

inReplyToMessageIdstring

ID of the message this message replied to

Example: gIQffAsGi8

membershipIdstringrequired

ID of the message author

Example: gIQffAsGi8

createdAtstring<date-time>required

Date and time the message was created

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

updatedAtstring<date-time>required

Date and time the message was last modified

Example: 2024-02-26T18:58:36.154+03:00

content objectrequired

Message content. At least one field is non-empty

textstring

Message in Markdown format

Example: Hi!

fileIdsstring[]

Array of file IDs attached to the message

Example: [ADK5NyCqIK, BDK5NyCqIK]

conferenceIdstring

Conference ID

Example: gIQffAsGi8

systemEvent object

System message content. At least one field is non-empty

chatCreated object

System message: chat created

creatorMembershipIdstringrequired

Membership ID of the chat creator

Example: ADK5NyCqIK

membershipIdsstring[]

Array of Membership IDs of the created chat's members

Example: [ADK5NyCqIK, BDK5NyCqIK]

chatConvertedToPrivate object

System message: chat created

initiatorMembershipIdstringrequired

Membership ID of the initiator of converting the chat to private

Example: ADK5NyCqIK

membersJoined object

System message: new members joined the chat

inviterMembershipIdstring

Membership ID of the member who invited the new members

Example: ADK5NyCqIK

membershipIdsstring[]required

Array of Membership IDs of the invited members

Example: [ADK5NyCqIK, BDK5NyCqIK]

membersLeft object

System message: members removed from the chat

kickerMembershipIdstring

Membership ID of the member who removed the members

Example: ADK5NyCqIK

membershipIdsstring[]required

Array of Membership IDs of the removed members

Example: [ADK5NyCqIK, BDK5NyCqIK]

chatRenamed object

System message: chat renamed

initiatorMembershipIdstringrequired

Membership ID of the member who renamed the chat

Example: ADK5NyCqIK

newNamestringrequired

New chat name

Example: Documentation

forwardedContent object

Content of the forwarded message

sourceWorkspaceIdstringrequired

ID of the workspace the message is forwarded from

Example: AIQffAsGi8

sourceChatIdstringrequired

ID of the chat the message is forwarded from

Example: w:AIQffAsGi8

forwardedMessages object[]required

Array of forwarded messages. The messages will not include information about reactions, threads, pinning, or whether the message is a reply to another message

Array [

0

1

2

3

4

5

6

7

8

9

]

userEvent object

Personal notification content. At least one field is non-empty

conferenceMissed object

Personal notification about a missed conference

conferenceIdstringrequired

Conference identifier

Example: ADK5NyCqIK

inviterMemberIdstring

Membership ID of the conference initiator

Example: ADK5NyCqIK

conferenceTarget objectrequired

Conference data. At least one field is non-empty

channelCall object

Conference in a chat

chatIdstringrequired

ID of the chat where the conference was initiated

Example: w:AIQffAsGi8

watercooler object

Personal call

scopestringrequired

Conference type. PUBLIC - public, other members can join without invites; PRIVATE - access by invite only

Possible values: [PRIVATE, PUBLIC]

Example: PUBLIC

membershipIdsstring[]required

Array of Membership IDs of the conference participants

Example: [ADK5NyCqIK, BDK5NyCqIK]

startedAtstring<date-time>required

Date and time the conference started

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

conferenceDeclined object

Personal notification about a declined conference

conferenceIdstringrequired

Conference identifier

Example: ADK5NyCqIK

inviterMemberIdstring

Membership ID of the conference initiator

Example: ADK5NyCqIK

conferenceTarget objectrequired

Conference data. At least one field is non-empty

channelCall object

Conference in a chat

chatIdstringrequired

ID of the chat where the conference was initiated

Example: w:AIQffAsGi8

watercooler object

Personal call

scopestringrequired

Conference type. PUBLIC - public, other members can join without invites; PRIVATE - access by invite only

Possible values: [PRIVATE, PUBLIC]

Example: PUBLIC

membershipIdsstring[]required

Array of Membership IDs of the conference participants

Example: [ADK5NyCqIK, BDK5NyCqIK]

startedAtstring<date-time>required

Date and time the conference started

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

conferenceDirectInvite object

Personal notification about a direct conference invite

conferenceIdstringrequired

Conference identifier

Example: ADK5NyCqIK

inviterMemberIdstring

Membership ID of the conference initiator

Example: ADK5NyCqIK

conferenceTarget objectrequired

Conference data. At least one field is non-empty

channelCall object

Conference in a chat

chatIdstringrequired

ID of the chat where the conference was initiated

Example: w:AIQffAsGi8

watercooler object

Personal call

scopestringrequired

Conference type. PUBLIC - public, other members can join without invites; PRIVATE - access by invite only

Possible values: [PRIVATE, PUBLIC]

Example: PUBLIC

membershipIdsstring[]required

Array of Membership IDs of the conference participants

Example: [ADK5NyCqIK, BDK5NyCqIK]

startedAtstring<date-time>required

Date and time the conference started

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

conferenceAnnounce object

Personal notification about the start of an available conference

conferenceIdstringrequired

Conference identifier

Example: ADK5NyCqIK

inviterMemberIdstring

Membership ID of the conference initiator

Example: ADK5NyCqIK

conferenceTarget objectrequired

Conference data. At least one field is non-empty

channelCall object

Conference in a chat

chatIdstringrequired

ID of the chat where the conference was initiated

Example: w:AIQffAsGi8

watercooler object

Personal call

scopestringrequired

Conference type. PUBLIC - public, other members can join without invites; PRIVATE - access by invite only

Possible values: [PRIVATE, PUBLIC]

Example: PUBLIC

membershipIdsstring[]required

Array of Membership IDs of the conference participants

Example: [ADK5NyCqIK, BDK5NyCqIK]

startedAtstring<date-time>required

Date and time the conference started

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

chatMessageMention object

Personal notification about a mention in a chat

chatIdstringrequired

ID of the chat the message was sent to

Example: w:AIQffAsGi8

chatMessage objectrequired

Message object

0

1

2

3

4

5

6

7

8

9

pollIdstring

Poll ID, if the message contains a poll

Example: gIQffAsGi8

reactions object[]

Array of reactions to the message

Array [

emojistringrequired

Emoji in the form :+1:

Example: :heart:

countintegerrequired

Number of reactions

Example: 5

]

threadIdstring

ID of the thread under this message

Example: t:AIQffAsGi8

pinnedAtstring<date-time>

Date and time the message was pinned

Example: 2024-02-26T18:58:36.154+03:00

notification object

Update object - notification

workspaceIdstringrequired

ID of the workspace the notification relates to

Example: AIQffAsGi8

timestampstring<date-time>required

Notification creation time

Example: 2024-02-26T18:58:36.154+03:00

memberJoinedEvent object

Notification that a new member has joined the workspace

memberIdstringrequired

Membership ID of the member who joined

Example: ADK5NyCqIK

memberInvitedEvent object

Notification that a new member has been invited to the workspace

memberIdstringrequired

Membership ID of the invited member

Example: ADK5NyCqIK

memberLeftEvent object

Notification that a member has left the workspace

memberIdstringrequired

Membership ID of the member who left the workspace

Example: ADK5NyCqIK

memberChangedRoleEvent object

Notification that a member's role in the workspace has changed

memberIdstringrequired

Membership ID of the member with the new role

Example: ADK5NyCqIK

newRoleWorkspaceRole (string)required

Member's new role

Possible values: [MEMBER, ADMIN, OWNER, GUEST, GUEST_CALLER]

Example: ADMIN

chatCreatedEvent object

Notification that a new chat has been created in the workspace

chatIdstringrequired

ID of the created chat

Example: w:AIQffAsGi8

metadata objectrequired

Contains chat-type-specific information. One of the fields is populated depending on the chat type

personal object

Contains information about the personal chat

otherMembershipIdstringrequired

MembershipId of the other party

Example: aIQffAsGia

workspace object

Information about the workspace chat

namestringrequired

Chat name

Example: News

announcebooleanrequired

Whether the chat is an announcement chat

Example: true

chatTypeWorkspaceChatType (string)required

Chat type

Possible values: [PRIVATE, PUBLIC, GENERAL]

Example: PUBLIC

autoJoinNewMembersbooleanrequired

Whether new workspace members are automatically added to the chat

Example: true

descriptionstring

Chat description

Example: Company news

memberCountintegerrequired

Number of members

Example: 5

thread object

Thread information

parentChatIdstringrequired

ChatId of the parent chat where the parent message is located

Example: w:aIQffAsGia

parentMessageIdstringrequired

MessageId of the parent message the thread belongs to

Example: bIQffAsGia

conference object

Conference chat information

conferenceIdstringrequired

Identifier of the conference the chat relates to

Example: dIQffAsGia

userEvents object

Information about the chat with personal notifications

ownerstringrequired

MembershipId of the owner

Example: aIQffAsGia

reactionToggledEvent object

Notification that a reaction to a message has been added/removed

chatIdstringrequired

ID of the chat containing the message with the reaction

Example: w:AIQffAsGi8

messageIdstringrequired

Message ID of the message with the reaction

Example: bIQffAsGia

emojistringrequired

Emoji in the form :+1:

Example: :heart:

reactedBystringrequired

Membership ID of the member who added or removed the reaction

Example: ADK5NyCqIK

wasSetbooleanrequired

If true, the reaction was added; otherwise it was removed

Example: true

messageEditedEvent object

Notification that a message has been edited

chatIdstringrequired

ID of the chat containing the edited message

Example: w:AIQffAsGi8

messageIdstringrequired

Message ID of the edited message

Example: bIQffAsGia

messageDeletedEvent object

Notification that a message has been deleted

chatIdstringrequired

ID of the chat that contained the deleted message

Example: w:AIQffAsGi8

messageIdstringrequired

Message ID of the deleted message

Example: bIQffAsGia

chatMemberJoinedEvent object

Notification of a new member in the chat

chatIdstringrequired

ID of the chat where the new member appeared

Example: w:AIQffAsGi8

memberIdstringrequired

Membership ID of the new chat member

Example: ADK5NyCqIK

chatMemberLeftEvent object

Notification that a member has left the chat

chatIdstringrequired

ID of the chat the member left

Example: w:AIQffAsGi8

memberIdstringrequired

Membership ID of the member who left the chat

Example: ADK5NyCqIK

chatMemberInvitedEvent object

Notification that a new member has been invited to the chat

chatIdstringrequired

ID of the chat the new member was invited to

Example: w:AIQffAsGi8

memberIdstringrequired

Membership ID of the invited member

Example: ADK5NyCqIK

inviterMemberIdstringrequired

Membership ID of the inviting member

Example: ADK5NyCqIK

chatMemberChangedRoleEvent object

Notification that a member's role in the chat has changed

chatIdstringrequired

ID of the chat that contained the deleted message

Example: w:AIQffAsGi8

memberIdstringrequired

Membership ID of the new chat member

Example: ADK5NyCqIK

newRoleChatRole (string)required

Member's new role

Possible values: [MEMBER, ADMIN, OWNER]

Example: ADMIN

chatArchivedEvent object

Notification that the chat has been archived

chatIdstringrequired

ID of the chat that was archived

Example: w:AIQffAsGi8

chatUnarchivedEvent object

Notification that the chat has been unarchived

chatIdstringrequired

ID of the chat that was unarchived

Example: w:AIQffAsGi8

pollVotedEvent object

Notification that poll votes have been updated

chatIdstringrequired

ID of the chat containing the poll

Example: w:AIQffAsGi8

messageIdstringrequired

Message ID of the poll message

Example: bIQffAsGia

pollIdstringrequired

Poll ID

Example: AIQffAsGi8

summary objectrequired

Summary of the poll results

votes object[]required

Array of vote counts per answer option

Array [

optionintegerrequired

Index of the answer option (starting from 0)

Example: 0

votesCountinteger<int64>required

Number of votes for this option

Example: 15

]

totalVotersinteger<int64>required

Total number of voters

Example: 42

firstVotedMemberIdsstring[]

Array of membershipId values of the first members who voted

myVoteinteger[]

Indices of the options the current user voted for

messageAction object

Update object - interactive message action (button press)

workspaceIdstringrequired

ID of the workspace the message belongs to

Example: AIQffAsGi8

chatIdstringrequired

ID of the chat the message belongs to

Example: w:AIQffAsGi8

messageIdstringrequired

Message ID

Example: gIQffAsGi8

pressedButtonCommand object

Command of the button that was pressed

displayTextstringrequired

Text on the button

Example: Press the button

commandKeystringrequired

Command sent when the button is pressed

Example: /button_pushed

workspaceInvite object

Update object - invite to a new workspace

workspaceIdstringrequired

ID of the workspace the bot was invited to

Example: AIQffAsGi8

inviterNamestringrequired

Name of the member who sent the invite

Example: John Smith

inviterEmailstringrequired

Email of the member who sent the invite

Example: ivanov@example.org

Update

{
  "updateId": 0,
  "message": {
    "workspaceId": "AIQffAsGi8",
    "chatId": "w:AIQffAsGi8",
    "messageId": "gIQffAsGi8",
    "messageType": "USER",
    "inReplyToMessageId": "gIQffAsGi8",
    "membershipId": "gIQffAsGi8",
    "createdAt": "2023-02-26T18:58:36.154+03:00",
    "updatedAt": "2024-02-26T18:58:36.154+03:00",
    "content": {
      "text": "Hi!",
      "fileIds": "[ADK5NyCqIK, BDK5NyCqIK]",
      "conferenceId": "gIQffAsGi8",
      "systemEvent": {
        "chatCreated": {
          "creatorMembershipId": "ADK5NyCqIK",
          "membershipIds": "[ADK5NyCqIK, BDK5NyCqIK]"
        },
        "chatConvertedToPrivate": {
          "initiatorMembershipId": "ADK5NyCqIK"
        },
        "membersJoined": {
          "inviterMembershipId": "ADK5NyCqIK",
          "membershipIds": "[ADK5NyCqIK, BDK5NyCqIK]"
        },
        "membersLeft": {
          "kickerMembershipId": "ADK5NyCqIK",
          "membershipIds": "[ADK5NyCqIK, BDK5NyCqIK]"
        },
        "chatRenamed": {
          "initiatorMembershipId": "ADK5NyCqIK",
          "newName": "Documentation"
        }
      },
      "forwardedContent": {
        "sourceWorkspaceId": "AIQffAsGi8",
        "sourceChatId": "w:AIQffAsGi8",
        "forwardedMessages": [
          {}
        ]
      },
      "userEvent": {
        "conferenceMissed": {
          "conferenceId": "ADK5NyCqIK",
          "inviterMemberId": "ADK5NyCqIK",
          "conferenceTarget": {
            "channelCall": {
              "chatId": "w:AIQffAsGi8"
            },
            "watercooler": {
              "scope": "PUBLIC",
              "membershipIds": "[ADK5NyCqIK, BDK5NyCqIK]"
            }
          },
          "startedAt": "2023-02-26T18:58:36.154+03:00"
        },
        "conferenceDeclined": {
          "conferenceId": "ADK5NyCqIK",
          "inviterMemberId": "ADK5NyCqIK",
          "conferenceTarget": {
            "channelCall": {
              "chatId": "w:AIQffAsGi8"
            },
            "watercooler": {
              "scope": "PUBLIC",
              "membershipIds": "[ADK5NyCqIK, BDK5NyCqIK]"
            }
          },
          "startedAt": "2023-02-26T18:58:36.154+03:00"
        },
        "conferenceDirectInvite": {
          "conferenceId": "ADK5NyCqIK",
          "inviterMemberId": "ADK5NyCqIK",
          "conferenceTarget": {
            "channelCall": {
              "chatId": "w:AIQffAsGi8"
            },
            "watercooler": {
              "scope": "PUBLIC",
              "membershipIds": "[ADK5NyCqIK, BDK5NyCqIK]"
            }
          },
          "startedAt": "2023-02-26T18:58:36.154+03:00"
        },
        "conferenceAnnounce": {
          "conferenceId": "ADK5NyCqIK",
          "inviterMemberId": "ADK5NyCqIK",
          "conferenceTarget": {
            "channelCall": {
              "chatId": "w:AIQffAsGi8"
            },
            "watercooler": {
              "scope": "PUBLIC",
              "membershipIds": "[ADK5NyCqIK, BDK5NyCqIK]"
            }
          },
          "startedAt": "2023-02-26T18:58:36.154+03:00"
        },
        "chatMessageMention": {
          "chatId": "w:AIQffAsGi8",
          "chatMessage": {}
        }
      },
      "pollId": "gIQffAsGi8"
    },
    "reactions": [
      {
        "emoji": ":heart:",
        "count": "5"
      }
    ],
    "threadId": "t:AIQffAsGi8",
    "pinnedAt": "2024-02-26T18:58:36.154+03:00"
  },
  "notification": {
    "workspaceId": "AIQffAsGi8",
    "timestamp": "2024-02-26T18:58:36.154+03:00",
    "memberJoinedEvent": {
      "memberId": "ADK5NyCqIK"
    },
    "memberInvitedEvent": {
      "memberId": "ADK5NyCqIK"
    },
    "memberLeftEvent": {
      "memberId": "ADK5NyCqIK"
    },
    "memberChangedRoleEvent": {
      "memberId": "ADK5NyCqIK",
      "newRole": "ADMIN"
    },
    "chatCreatedEvent": {
      "chatId": "w:AIQffAsGi8",
      "metadata": {
        "personal": {
          "otherMembershipId": "aIQffAsGia"
        },
        "workspace": {
          "name": "News",
          "announce": "true",
          "chatType": "PUBLIC",
          "autoJoinNewMembers": "true",
          "description": "Company news",
          "memberCount": "5"
        },
        "thread": {
          "parentChatId": "w:aIQffAsGia",
          "parentMessageId": "bIQffAsGia"
        },
        "conference": {
          "conferenceId": "dIQffAsGia"
        },
        "userEvents": {
          "owner": "aIQffAsGia"
        }
      }
    },
    "reactionToggledEvent": {
      "chatId": "w:AIQffAsGi8",
      "messageId": "bIQffAsGia",
      "emoji": ":heart:",
      "reactedBy": "ADK5NyCqIK",
      "wasSet": "true"
    },
    "messageEditedEvent": {
      "chatId": "w:AIQffAsGi8",
      "messageId": "bIQffAsGia"
    },
    "messageDeletedEvent": {
      "chatId": "w:AIQffAsGi8",
      "messageId": "bIQffAsGia"
    },
    "chatMemberJoinedEvent": {
      "chatId": "w:AIQffAsGi8",
      "memberId": "ADK5NyCqIK"
    },
    "chatMemberLeftEvent": {
      "chatId": "w:AIQffAsGi8",
      "memberId": "ADK5NyCqIK"
    },
    "chatMemberInvitedEvent": {
      "chatId": "w:AIQffAsGi8",
      "memberId": "ADK5NyCqIK",
      "inviterMemberId": "ADK5NyCqIK"
    },
    "chatMemberChangedRoleEvent": {
      "chatId": "w:AIQffAsGi8",
      "memberId": "ADK5NyCqIK",
      "newRole": "ADMIN"
    },
    "chatArchivedEvent": {
      "chatId": "w:AIQffAsGi8"
    },
    "chatUnarchivedEvent": {
      "chatId": "w:AIQffAsGi8"
    },
    "pollVotedEvent": {
      "chatId": "w:AIQffAsGi8",
      "messageId": "bIQffAsGia",
      "pollId": "AIQffAsGi8",
      "summary": {
        "votes": [
          {
            "option": 0,
            "votesCount": 15
          }
        ],
        "totalVoters": 42,
        "firstVotedMemberIds": [
          "string"
        ]
      },
      "myVote": [
        0
      ]
    }
  },
  "messageAction": {
    "workspaceId": "AIQffAsGi8",
    "chatId": "w:AIQffAsGi8",
    "messageId": "gIQffAsGi8",
    "pressedButtonCommand": {
      "displayText": "Press the button",
      "commandKey": "/button_pushed"
    }
  },
  "workspaceInvite": {
    "workspaceId": "AIQffAsGi8",
    "inviterName": "John Smith",
    "inviterEmail": "ivanov@example.org"
  }
}