PlanewardPlaneward Docs
PlanewardPlaneward Docs
Welcome

Developers

REST APIAuthenticationWebhooksMCPEmbedded projectsTask description contentDeveloper hub

API

List community members GETGet a community member GETList messages in a channel GETPost a message as the app POSTList channels GETList courses GETGet a course outline GETList a member's course progress GETUncomplete a module for a member DELETEComplete a module for a member PUTList the app's badges GETCreate or update a badge by key POSTUpdate a badge PATCHDelete a badge DELETERevoke a badge from a member DELETEAward a badge to a member PUTSend a notification to members POST
Community

Post a message as the app

Requires `COMMUNITY_MESSAGES_WRITE` and an app caller (`pwa_` secret); workspace API keys get 403. The channel must be a text channel in the workspace's community. The app posts with the rights of the `@everyone` role, after category and channel overwrites; staff roles never apply. If `@everyone` can't view the channel the response is 404 "Channel not found." so private channels look missing. If `@everyone` can view but not send messages the response is 403 "This app can't post in that channel.". `replyToId` must be a top-level message in the same channel (one level of replies). The message is shown live under the app's name; members cannot edit it, moderators can delete it.

POST
/community/channels/{channelId}/messages

Requires COMMUNITY_MESSAGES_WRITE and an app caller (pwa_ secret); workspace API keys get 403. The channel must be a text channel in the workspace's community. The app posts with the rights of the @everyone role, after category and channel overwrites; staff roles never apply. If @everyone can't view the channel the response is 404 "Channel not found." so private channels look missing. If @everyone can view but not send messages the response is 403 "This app can't post in that channel.". replyToId must be a top-level message in the same channel (one level of replies). The message is shown live under the app's name; members cannot edit it, moderators can delete it.

Authorization

x-api-key<token>

In: header

Path Parameters

channelId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/community/channels/string/messages" \  -H "Content-Type: application/json" \  -d '{    "body": "string"  }'
{  "data": {    "id": "string",    "channelId": "string",    "body": "string",    "replyToId": "string",    "createdAt": "2019-08-24T14:15:22Z",    "author": {      "kind": "app",      "installationId": "string",      "name": "string"    }  }}

List messages in a channel GET

Requires `COMMUNITY_MESSAGES_READ` (`COMMUNITY_MESSAGES_WRITE` alone is not enough). Newest first, with reaction counts. Only channels `@everyone` can view; others are 404 "Channel not found." so private channels look missing. Deleted messages are left out. Page with `cursor`: pass the previous response's `meta.nextCursor` until it is null.

List channels GET

Requires `COMMUNITY_MESSAGES_READ` (`COMMUNITY_MESSAGES_WRITE` also works, so an app that only posts can find a channel). Text and app channels the `@everyone` role can view, after category and channel overwrites, in sidebar order. App channels whose app is uninstalled or no longer available are left out. Private channels are never listed. Returns 403 when the Community module is disabled and 404 when the workspace has no community.

body*string
Length1 <= length <= 4000
replyToId?string