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 the app's badges

Requires `COMMUNITY_BADGES_WRITE` and an app caller (`pwa_` secret); workspace API keys get 403. Badges this app defined in the installing workspace, oldest first.

GET
/community/badges

Requires COMMUNITY_BADGES_WRITE and an app caller (pwa_ secret); workspace API keys get 403. Badges this app defined in the installing workspace, oldest first.

Authorization

x-api-key<token>

In: header

Response Body

application/json

application/json

curl -X GET "https://example.com/community/badges"
{  "data": [    {      "id": "string",      "appId": "string",      "key": "string",      "name": "string",      "description": "string",      "color": "string",      "iconUrl": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ]}

Complete a module for a member PUT

Requires `COURSE_PROGRESS_WRITE`. Marks the module complete for the member. Safe to repeat: an already completed module keeps its original `completedAt`. Works for any module of a course members can see (published and sold through at least one product), whatever the member's plan. Emits `community.module.completed`, and `community.course.completed` when this completes the course, at most once per member and course (uncompleting and completing the last module again does not repeat it). The member must be `ACTIVE`.

Create or update a badge by key POST

Requires `COMMUNITY_BADGES_WRITE` and an app caller. `key` is the app's stable slug for the badge: posting an existing key updates that badge (200), a new key creates one (201). Badges belong to the app in this workspace, so they come back with their awards after a reinstall. An app can have at most 50 badges per workspace; a new key past that is 409.