Перейти к основному содержимому
Версия: v2

Notification

Тип обновления - уведомление. Содержит Id рабочего пространства, время создания и одно заполненное поле, в зависимости от вида уведомления

workspaceIdstringrequired

Id рабочего пространства, к которому относится уведомление

Example: AIQffAsGi8
timestampstring<date-time>required

Время создания уведомления

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

Уведомление о присоединении нового участника к рабочему пространству

memberIdstringrequired

Membership Id присоединившегося участника

Example: ADK5NyCqIK
memberInvitedEvent object

Уведомление о приглашении нового участника в рабочее пространство

memberIdstringrequired

Membership Id приглашенного участника

Example: ADK5NyCqIK
memberLeftEvent object

Уведомление о выходе участника из рабочего пространства

memberIdstringrequired

Membership Id участника, покинувшего рабочее пространство

Example: ADK5NyCqIK
memberChangedRoleEvent object

Уведомление об изменении роли участника в рабочем пространстве

memberIdstringrequired

Membership Id участника с новой ролью

Example: ADK5NyCqIK
newRoleWorkspaceRole (string)required

Новая роль участника

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

Example: ADMIN
chatCreatedEvent object

Уведомление о создании нового чата в рабочем пространстве

chatIdstringrequired

Id созданного чата

Example: w:AIQffAsGi8
metadata objectrequired

Содержит специфичную для типа чата информацию. Заполняется одно из полей в зависимости от типа чата

personal object

Содержит информацию о персональном чате

otherMembershipIdstringrequired

MembershipId собеседника

Example: aIQffAsGia
workspace object

Информация о чате в рабочем пространстве

namestringrequired

Название чата

Example: Новости
announcebooleanrequired

Является ли чат анонсным

Example: true
chatTypeWorkspaceChatType (string)required

Тип чата

Possible values: [PRIVATE, PUBLIC, GENERAL]

Example: PUBLIC
autoJoinNewMembersbooleanrequired

Добавляются ли автоматически новые участники рабочего пространства в чат

Example: true
descriptionstring

Описание чата

Example: Новости компании
memberCountintegerrequired

Число участников

Example: 5
thread object

Информация об обсуждении

parentChatIdstringrequired

ChatId родительского чата, где расположено родительское сообщение

Example: w:aIQffAsGia
parentMessageIdstringrequired

MessageId родительского сообщения, к которому относится обсуждение

Example: bIQffAsGia
conference object

Информация о чате конференции

conferenceIdstringrequired

Идентификатор конференции, к которой относится чат

Example: dIQffAsGia
userEvents object

Информация о чате с персональными нотификациями

ownerstringrequired

MembershipId владельца

Example: aIQffAsGia
reactionToggledEvent object

Уведомление о добавлении/удалении реакции на сообщение

chatIdstringrequired

Id чата, в котором содержится сообщение с реакцией

Example: w:AIQffAsGi8
messageIdstringrequired

Message Id сообщения с реакцией

Example: bIQffAsGia
emojistringrequired

Emoji в виде :+1:

Example: :heart:
reactedBystringrequired

Membership Id участника, который поставил или убрал реакцию

Example: ADK5NyCqIK
wasSetbooleanrequired

Если значение true - реакция была поставлена, в противном случае - убрана

Example: true
messageEditedEvent object

Уведомление об изменении сообщения

chatIdstringrequired

Id чата, в котором содержится измененное сообщение

Example: w:AIQffAsGi8
messageIdstringrequired

Message Id измененного сообщения

Example: bIQffAsGia
messageDeletedEvent object

Уведомление об удалении сообщения

chatIdstringrequired

Id чата, в котором содержалось удаленное сообщение

Example: w:AIQffAsGi8
messageIdstringrequired

Message Id удаленного сообщения

Example: bIQffAsGia
chatMemberJoinedEvent object

Уведомление о новом участнике в чате

chatIdstringrequired

Id чата, в котором появился новый участник

Example: w:AIQffAsGi8
memberIdstringrequired

Membership Id нового участника чата

Example: ADK5NyCqIK
chatMemberLeftEvent object

Уведомление о том, что участник покинул чат

chatIdstringrequired

Id чата, который покинул частник

Example: w:AIQffAsGi8
memberIdstringrequired

Membership Id участника, который покинул чат

Example: ADK5NyCqIK
chatMemberInvitedEvent object

Уведомление о приглашении нового участника в чат

chatIdstringrequired

Id чата, в который пригласили нового участника

Example: w:AIQffAsGi8
memberIdstringrequired

Membership Id приглашенного участника

Example: ADK5NyCqIK
inviterMemberIdstringrequired

Membership Id пригласившего участника

Example: ADK5NyCqIK
chatMemberChangedRoleEvent object

Уведомление об изменении роли участника в чате

chatIdstringrequired

Id чата, в котором содержалось удаленное сообщение

Example: w:AIQffAsGi8
memberIdstringrequired

Membership Id нового участника чата

Example: ADK5NyCqIK
newRoleChatRole (string)required

Новая роль участника

Possible values: [MEMBER, ADMIN, OWNER]

Example: ADMIN
chatArchivedEvent object

Уведомление об архивации чата

chatIdstringrequired

Id чата, который был архивирован

Example: w:AIQffAsGi8
chatUnarchivedEvent object

Уведомление об разархивации чата

chatIdstringrequired

Id чата, который был разархивирован

Example: w:AIQffAsGi8
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": "Новости",
"announce": "true",
"chatType": "PUBLIC",
"autoJoinNewMembers": "true",
"description": "Новости компании",
"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"
}
}