Communities

This page will guide you through the steps you need to take to integrate community chat groups into your applications for Web

Community Description
Name
Data Type
Description
Attributes
communityId
String
ID of the community
​
channelId
String
ID of the channel
​
userId
String
ID of the user who created the comment
​
displayName
String
Community name for displaying
​
avatarFileId
String
ID of the avatar file
​
description
String
Description of the community
​
isOfficial
Boolean
Is this community official?
​
isPublic
Boolean
Is this community public?
​
onlyAdminCanPost
Boolean
Can post by admin only?
​
tags
Array.<String>
List of tags used for searching
​
metadata
Object
Additional properties to support custom fields
​
postsCount
Integer
Number of posts in community
​
membersCount
Integer
Number of members in community
​
isJoined
Boolean
Is this community joined?
​
categoryIds
Array.<String>
ID of categories
​
isDeleted
Boolean
Is this community deleted?
Default: false
createdAt
String($date-time)
Date/time when the community was created
​
updatedAt
String($date-time)
Date/time when a community is updated or deleted
​
hasFlaggedComment
Boolean
Flag for checking internally if comment inside post is reported or not
Default: false
hasFlaggedPost
Boolean
Flag for checking internally if post inside community is reported or not
Default: false
needApprovalOnPostCreation
Boolean
Determines if the community requires an authorized user to review post before post will be published
Default: false
​

Web

Create Community

Last modified 2mo ago

Name	Data Type	Description	Attributes
`communityId`	`String`	ID of the community
`channelId`	`String`	ID of the channel
`userId`	`String`	ID of the user who created the comment
`displayName`	`String`	Community name for displaying
`avatarFileId`	`String`	ID of the avatar file
`description`	`String`	Description of the community
`isOfficial`	`Boolean`	Is this community official?
`isPublic`	`Boolean`	Is this community public?
`onlyAdminCanPost`	`Boolean`	Can post by admin only?
`tags`	`Array.<String>`	List of tags used for searching
`metadata`	`Object`	Additional properties to support custom fields
`postsCount`	`Integer`	Number of posts in community
`membersCount`	`Integer`	Number of members in community
`isJoined`	`Boolean`	Is this community joined?
`categoryIds`	`Array.<String>`	ID of categories
`isDeleted`	`Boolean`	Is this community deleted?	Default: `false`
`createdAt`	`String($date-time)`	Date/time when the community was created
`updatedAt`	`String($date-time)`	Date/time when a community is updated or deleted
`hasFlaggedComment`	`Boolean`	Flag for checking internally if comment inside post is reported or not	Default: `false`
`hasFlaggedPost`	`Boolean`	Flag for checking internally if post inside community is reported or not	Default: `false`
`needApprovalOnPostCreation`	`Boolean`	Determines if the community requires an authorized user to review post before post will be published	Default: `false`