UserEvent

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

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

forwardedMessagesundefined[]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

userEvent

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

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": {
      "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": [
            null
          ]
        },
        "pollId": "gIQffAsGi8"
      },
      "reactions": [
        {
          "emoji": ":heart:",
          "count": "5"
        }
      ],
      "threadId": "t:AIQffAsGi8",
      "pinnedAt": "2024-02-26T18:58:36.154+03:00"
    }
  }
}