Skip to main content

Groups Data Modal

COTGroup

Description​

Groups are the standard form of interacting within the Cotalker environment and are primarily accessed through the Main Menu Bar and Group Panel. There are three types of groups. Standard groups contain channels used for communicating with other users. Workflow groups, like standard groups, have communication channels but are associated with workflow tasks and their states. Link groups direct you to anywhere within or outside the Cotalker environment.

JSON Sample​

{
    "_id": "618a9a1c881d93046349c820",
    "actions": [
        {
            "auth": false,
            "display": "Go to statistics page",
            "external": true,
            "icon": "M17.9,17.39C17.64,16.59 16.89,16 16,16H15V13A1,1 0 0,0 14,12H8V10H10A1,1 0 0,0 11,9V7H13A2,2 0 0,0 15,5V4.59C17.93,5.77 20,8.64 20,12C20,14.08 19.2,15.97 17.9,17.39M11,19.93C7.05,19.44 4,16.08 4,12C4,11.38 4.08,10.78 4.21,10.21L9,15V16A2,2 0 0,0 11,18M12,2A10,10 0 0,0 2,12A10,10 0 0,0 12,22A10,10 0 0,0 22,12A10,10 0 0,0 12,2Z",
            "url": "https://www.mystatistics.com"
        }
    ],
    "color": "#ffffff",
    "company": "618a9a23a1e8b667232eda73",
    "createChannels": {
        "active": true,
        "requiredPermission": [],
        "requiredPermissionsV2": [
            "admin-groups-write"
        ],
    },
    "createdAt": "2021-08-31T15:07:24.955Z",
    "groupBy": null,
    "groupSort": "weight",
    "groupSortDirection": "desc",
    "help": {
        "animation": "",
        "faqUrl": "https://www.companyfaq.com",
        "isActive": true,
        "onboarding": true,
        "text": "Call Saul for help."
    },
    "icon": "M17,12V3A1,1 0 0,0 16,2H3A1,1 0 0,0 2,3V17L6,13H16A1,1 0 0,0 17,12M21,6H19V15H6V17A1,1 0 0,0 7,18H18L22,22V7A1,1 0 0,0 21,6Z",
    "isActive": true,
    "innerSort": "createdAt",
    "innerSortDirection": "desc",
    "link": {
        "requiredPermission": [],
        "requiredPermissionsV2": null
    },
    "modifiedAt": "2021-09-08T17:48:55.709Z",
    "nameCode": "team_chat_00",
    "nameDisplay": "Team Chats",
    "parent": null,
    "weight": 2
}

Fields​

FieldsDescriptionTypeNotes
_idGroup ID numberObjectId<COTGroup>
actionsList of links that can be opened from the group panel's action buttonobject[ ]
actions[index]._idSystem generated IDObjectId
actions[index].displayText displayed to indicate the link to be openedstring
actions[index].authIndicates if authentication data is sentboolean
actions[index].externalIndicates if the link opens in another tab or not; if not, the link will be embedded in a window that opens up over the platformbooleanNot all URLs will open up in the embedded pop-up window
actions[index].iconThe link's icon in the actions button's menustringsvg code
actions[index].urlThe link's addressstringURL
actions[index].weightIndicates the link's place in the menunumberNumbers do not have to be in consecutive order; lower numbers go first
channelsWithoutCategoryLocationstringOptions are: top or hide
colorThe color of the group icon in the Main Menu BarstringHex color code
companyCompany ObjectIdObjectId<COTCompany>Company Data Model
createChannelsAllows users to create new channels within the groupobject
createChannels.activeIndicates whether or not users can create new channels within the groupboolean
createChannels.requiredPermissionArray of the access role IDs users need to create new channelsObjectId<COTAccessRole>[ ]Access Roles Data Model
createChannels.requiredPermissionsV2Array of permission names users need to create new channelsstring[ ]List of default persmission names
createdAtGroup creation dateISODateYYYY-MM-DDTHH:mm:ss.SSSZ
groupBySorts channels within group by collection elements; useful for sorting task channels by their current stateObjectId<COTPropertyType>Collection Data Model
groupSortSorts the collection elements through which channels will be arrangedstringOptions: weight, modifiedAt, createdAt, a-z
groupSortDirectionThe direction of sorted elementsstringasc or desc
helpSets up help and onboardingobject
help.animationAnimated image (JSON) shown in the group's onboardingstringWe recommend using Lottie File
help.faqUrlIndicates the FAQ's addressstringURL
help.isActiveIndicates if help option is activatedboolean
help.onboardingIf it is active it will show up after you log in the App or Websiteboolean
help.textText to be displayed in the onboardingstringWill be displayed below the animation
hideChannelsByPropertiesArray of elements or properties; channels with these elements will be hiddenObjectId<COTProperty>Elements Data Model
iconIcon that represents the group on the Main Menu BarstringSVG code
innerSortSorts channels within the groupstringmodifiedAt, createdAt, a-z, lastMessage
innerSortDirectionIndicates whether sorting order is ascending or descending.stringOptions are: asc or desc
isActiveIndicates if group is active or has been deactivatedboolean
isCategoryIndicates whether the group is a category, i.e., if it contains sub-groups within the Main Menu Bar.booleanThis field is used in conjunction with the nestedGroups field.
linkSettings for link groups that appear on the Main Menu Barobject
link.authSends user's authentication tokenboolean
link.cmdstring
link.embeddedEmbeds link into the platform windowboolean
link.externalOpens link in new tabboolean
link.linkTypeIndicates the type of linkstringOptions are: URL, APK
link.requiredPermissionArray of access role IDs users must have to access the linkObjectId<COTAccessRole>[ ]Access Roles Data Model
link.requiredPermissionsV2Array of permission names users need to access the linkstring[ ]Default persmissions
link.tokenKeystring
link.urlComplete web address linkstringURL
modifiedAtLast date and time the group was modifiedISODateYYYY-MM-DDTHH:mm:ss.SSSZ
nameCodeThe group's unique identification namestringMaximum 60 characters; only lowercase letters, numbers, and underscore allowed; must be unique.
nameDisplayThe group name users see on the platformstring
nestedGroupsContains the ObjectIds of the groups in a category displayed as a sub-menu on the Main Menu Bar. Must be used in conjunction with the isCategory field.ObjectId<COTGroup>[ ]More information in the Categories section.
parentIndicates the parent group, making the child group appear in the parent's group panel.ObjectId<COTGroup>
searchArray of automatically generated search keywords string [ ]
viewSettingsSets the initial display type for workflow groups.object
viewSettings.initialViewIndicates the chosen display type for the workflow group. Possible values include task (task view) and group (group view).stringClick here for more details about initial views.
weightIndicates the group's place in the Main Menu BarnumberNumbers do not have to be in consecutive order; lower numbers go first

Deprecated or not to be used​

FieldsDescriptionTypeNotes
__vVersion numbernumberNot to be modified
apperanceobjectDEPRECATED
canViewChannelsConfigobjectDEPRECATED
channelsArray of channels found in the groupObjectId<COTChannel>[ ]DEPRECATED
createChannels.allowedContentTypesArraystring[ ]DEPRECATED
createChannels.openChannelbooleanDEPRECATED
defaultChannelobjectDEPRECATED
defaultOpenBehaviorstringchannel, link or task
filtersArrayobject[ ]DEPRECATED
groupNumbernumberDEPRECATED
groupOwnerIdsArray[ ]DEPRECATED
help.imagestringDEPRECATED
imageobjectDEPRECATED
propertyLevelsConfigArrayobject[ ]DEPRECATED
propertyTypesArrayDEPRECATED
settingsobjectDEPRECATED
skipChannelSelectionbooleanDEPRECATED
showByLevelbooleanDEPRECATED
sortActivebooleanDEPRECATED
subdisplaySubtitlestringDEPRECATED
taskManagerobjectDEPRECATED
taskobjectDEPRECATED
userFilterbooleanDEPRECATED
visibilityobjectDEPRECATED

Additional Resources​

Help​