--- url: /apidocs/community.md --- ## Community API Community API handles communities and community channels (posts and discussions). | Endpoint | Method | Description | |-----|-----|-----| | [community:createCommunity](#create-community) | websocket | Create community | | [community:deleteCommunity](#delete-community) | websocket | Delete community | | [community:updateCommunity](#update-community) | websocket | Update community | | [community:searchCommunities](#search-communities) | websocket | Search communities | | [community:searchCommunitiesForCMS](#search-communities-for-cms) | websocket | Search communities for cMS | | ~~[community:searchOpenCommunities](#search-open-communities)~~ | websocket | Search open communities | | ~~[community:searchUserCommunities](#search-user-communities)~~ | websocket | Search user communities | | [community:getInfoAndSubscribe](#get-community-info-and-subscribe) | websocket | Get community info and subscribe | | [community:joinCommunity](#join-community) | websocket | Join community | | [community:leaveCommunity](#leave-community) | websocket | Leave community | | [community:inviteToCommunity](#invite-to-community) | websocket | Invite to community | | [community:cancelCommunityInvitationRequest](#cancel-community-invitation-request) | websocket | Cancel community invitation request | | [community:updateCommunityParticipant](#update-community-participant) | websocket | Update community participant | | [community:deleteCommunityParticipant](#delete-community-participant) | websocket | Delete community participant | | [community:transferCommunityOwnership](#transfer-community-ownership) | websocket | Transfer community ownership | | [community:searchCommunityParticipants](#search-community-participants) | websocket | Search community participants | | [community:searchPendingCommunityParticipants](#search-pending-community-participants) | websocket | Search pending community participants | | [community:requestCommunityJoin](#request-community-join) | websocket | Request community join | | [community:cancelCommunityJoinRequest](#cancel-community-join-request) | websocket | Cancel community join request | | [community:acceptCommunityJoinRequest](#accept-community-join-request) | websocket | Accept community join request | | [community:declineCommunityJoinRequest](#decline-community-join-request) | websocket | Decline community join request | | [community:searchPendingCommunityJoinRequests](#search-pending-community-join-requests) | websocket | Search pending community join requests | | [community:pinCommunity](#pin-community) | websocket | Pin community | | [community:unpinCommunity](#unpin-community) | websocket | Unpin community | | [community:createCommunityChannel](#create-community-channel) | websocket | Create community channel | | [community:deleteCommunityChannel](#delete-community-channel) | websocket | Delete community channel | | [community:updateCommunityChannel](#update-community-channel) | websocket | Update community channel | | [community:searchCommunityChannels](#search-community-channels) | websocket | Search community channels | | [community:getChannelInfoAndSubscribe](#get-community-channel-info-and-subscribe) | websocket | Get community channel info and subscribe | | ~~[community:createCommunityChannelPost](#create-community-channel-post)~~ | websocket | Create community channel post | | ~~[community:deleteCommunityChannelPost](#delete-community-channel-post)~~ | websocket | Delete community channel post | | ~~[community:editCommunityChannelPost](#edit-community-channel-post)~~ | websocket | Edit community channel post | | ~~[community:listCommunityChannelPosts](#list-community-channel-posts)~~ | websocket | List community channel posts | | ~~[community:listCommunityChannelComments](#list-community-channel-comments)~~ | websocket | List community channel comments | | ~~[community:listCommunityChannelThreadComments](#list-community-channel-thread-comments)~~ | websocket | List community channel thread comments | | ~~[community:setVoteForCommunityChannelPost](#set-vote-for-community-channel-post)~~ | websocket | Set vote for community channel post | | ~~[community:setVoteForCommunityChannelComment](#set-vote-for-community-channel-comment)~~ | websocket | Set vote for community channel comment | | ~~[community:setVoteForCommunityMessage](#set-vote-for-community-message)~~ | websocket | Set vote for community message | | [community:onChannelCreated](#on-community-channel-created-event) | websocketEvent | On community channel created event | | [community:onChannelDeleted](#on-community-channel-deleted-event) | websocketEvent | On community channel deleted event | | [community:onChannelUpdated](#on-community-channel-created-updated) | websocketEvent | On community channel created updated | | ~~[community:onChannelPostCreated](#on-community-channel-post-created-event)~~ | websocketEvent | On community channel post created event | | ~~[community:onChannelPostDeleted](#on-community-channel-post-deleted-event)~~ | websocketEvent | On community channel post deleted event | | ~~[community:onChannelPostUpdated](#on-community-channel-post-updated-event)~~ | websocketEvent | On community channel post updated event | ### Create community **Method:** websocket **Endpoint:** community:createCommunity **Request:** **Response:** ### Delete community **Method:** websocket **Endpoint:** community:deleteCommunity **Request:** **Response:** ### Update community **Method:** websocket **Endpoint:** community:updateCommunity **Request:** **Response:** ### Search communities **Method:** websocket **Endpoint:** community:searchCommunities **Request:** **Response:** ### Search communities for cMS **Method:** websocket **Endpoint:** community:searchCommunitiesForCMS **Description:** Same as community:searchCommunities, but additionally returns indexation state (filled by RAG) of each returned community's community:{communityId} belonging, keyed by communityId. **Request:** **Response:** ### Search open communities **Method:** websocket **Endpoint:** community:searchOpenCommunities **DEPRECATED** **Request:** **Response:** ### Search user communities **Method:** websocket **Endpoint:** community:searchUserCommunities **DEPRECATED** **Request:** **Response:** ### Get community info and subscribe **Method:** websocket **Endpoint:** community:getInfoAndSubscribe **Description:** Api returns community info and subscribes user to community events. **Request:** **Response:** ### Join community **Method:** websocket **Endpoint:** community:joinCommunity **Request:** **Response:** ### Leave community **Method:** websocket **Endpoint:** community:leaveCommunity **Request:** **Response:** ### Invite to community **Method:** websocket **Endpoint:** community:inviteToCommunity **Request:** **Response:** ### Cancel community invitation request **Method:** websocket **Endpoint:** community:cancelCommunityInvitationRequest **Request:** **Response:** ### Update community participant **Method:** websocket **Endpoint:** community:updateCommunityParticipant **Request:** **Response:** ### Delete community participant **Method:** websocket **Endpoint:** community:deleteCommunityParticipant **Request:** **Response:** ### Transfer community ownership **Method:** websocket **Endpoint:** community:transferCommunityOwnership **Request:** **Response:** ### Search community participants **Method:** websocket **Endpoint:** community:searchCommunityParticipants **Request:** **Response:** ### Search pending community participants **Method:** websocket **Endpoint:** community:searchPendingCommunityParticipants **Request:** **Response:** ### Request community join **Method:** websocket **Endpoint:** community:requestCommunityJoin **Request:** **Response:** ### Cancel community join request **Method:** websocket **Endpoint:** community:cancelCommunityJoinRequest **Request:** **Response:** ### Accept community join request **Method:** websocket **Endpoint:** community:acceptCommunityJoinRequest **Request:** **Response:** ### Decline community join request **Method:** websocket **Endpoint:** community:declineCommunityJoinRequest **Request:** **Response:** ### Search pending community join requests **Method:** websocket **Endpoint:** community:searchPendingCommunityJoinRequests **Request:** **Response:** ### Pin community **Method:** websocket **Endpoint:** community:pinCommunity **Request:** **Response:** ### Unpin community **Method:** websocket **Endpoint:** community:unpinCommunity **Request:** **Response:** ### Create community channel **Method:** websocket **Endpoint:** community:createCommunityChannel **Request:** **Response:** ### Delete community channel **Method:** websocket **Endpoint:** community:deleteCommunityChannel **Request:** **Response:** ### Update community channel **Method:** websocket **Endpoint:** community:updateCommunityChannel **Request:** **Response:** ### Search community channels **Method:** websocket **Endpoint:** community:searchCommunityChannels **Request:** **Response:** ### Get community channel info and subscribe **Method:** websocket **Endpoint:** community:getChannelInfoAndSubscribe **Description:** Api returns community channel info and subscribes user to community channel events. **Request:** **Response:** ### Create community channel post **Method:** websocket **Endpoint:** community:createCommunityChannelPost **DEPRECATED** **Description:** DEPRECATED, use `channel:createMessage` instead. **Request:** **Response:** ### Delete community channel post **Method:** websocket **Endpoint:** community:deleteCommunityChannelPost **DEPRECATED** **Description:** DEPRECATED, use `channel:deleteMessageFromChannel` instead. **Request:** **Response:** ### Edit community channel post **Method:** websocket **Endpoint:** community:editCommunityChannelPost **DEPRECATED** **Description:** DEPRECATED, use `channel:editMessageBody` instead. **Request:** **Response:** ### List community channel posts **Method:** websocket **Endpoint:** community:listCommunityChannelPosts **DEPRECATED** **Description:** DEPRECATED, use `channel:listMessagesWithEngagement` instead. **Request:** **Response:** ### List community channel comments **Method:** websocket **Endpoint:** community:listCommunityChannelComments **DEPRECATED** **Description:** DEPRECATED, use `channel:listMessagesWithEngagement` instead. **Request:** **Response:** ### List community channel thread comments **Method:** websocket **Endpoint:** community:listCommunityChannelThreadComments **DEPRECATED** **Description:** DEPRECATED, use `channel:listMessagesWithEngagement` instead. **Request:** **Response:** ### Set vote for community channel post **Method:** websocket **Endpoint:** community:setVoteForCommunityChannelPost **DEPRECATED** **Description:** DEPRECATED, use `channel:setVoteForMessage` instead. **Request:** **Response:** ### Set vote for community channel comment **Method:** websocket **Endpoint:** community:setVoteForCommunityChannelComment **DEPRECATED** **Description:** DEPRECATED, use `channel:setVoteForMessage` instead. **Request:** **Response:** ### Set vote for community message **Method:** websocket **Endpoint:** community:setVoteForCommunityMessage **DEPRECATED** **Description:** DEPRECATED, use `channel:setVoteForMessage` instead. **Request:** **Response:** ### On community channel created event **Event:** community:onChannelCreated **Description:** Event is triggered when a new channels is created in a community. **Data:** ### On community channel deleted event **Event:** community:onChannelDeleted **Description:** Event is triggered when a channel is deleted in a community. **Data:** ### On community channel created updated **Event:** community:onChannelUpdated **Description:** Event is triggered when a new channels is created in a community. **Data:** ### On community channel post created event **Event:** community:onChannelPostCreated **DEPRECATED** **Description:** DEPRECATED, use `channel:onMessageCreated` instead. **Data:** ### On community channel post deleted event **Event:** community:onChannelPostDeleted **DEPRECATED** **Description:** DEPRECATED, use `channel:onMessageDeleted` instead. **Data:** ### On community channel post updated event **Event:** community:onChannelPostUpdated **DEPRECATED** **Description:** Event is triggered when a message is updated in a community channel. DEPRECATED, use `channel:onMessageEdited` instead. **Data:** ## Models #### User Simple