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

List messages in a channel

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.

GET
/community/channels/{channelId}/messages

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.

Authorization

x-api-key<token>

In: header

Path Parameters

channelId*string

Query Parameters

cursor?string

Opaque cursor from the previous page's meta.nextCursor. Omit for the first page.

limit?integer
Range1 <= value <= 100
Default50

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/community/channels/string/messages"
{  "data": [    {      "id": "string",      "channelId": "string",      "body": "string",      "replyToId": "string",      "createdAt": "2019-08-24T14:15:22Z",      "editedAt": "2019-08-24T14:15:22Z",      "author": {        "kind": "member",        "memberId": "string",        "installationId": "string",        "name": "string"      },      "reactions": [        {          "emoji": "string",          "count": 1        }      ]    }  ],  "meta": {    "nextCursor": "string"  }}

Get a community member GET

Requires `COMMUNITY_MEMBERS_READ`.

Post a message as the app POST

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.