Notification

Update type - notification. Contains the workspace ID, creation time, and one populated field depending on the notification kind

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

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
    ]
  }
}