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

Create or update a badge by key

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.

POST
/community/badges

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.

Authorization

x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/community/badges" \  -H "Content-Type: application/json" \  -d '{    "key": "string",    "name": "string",    "color": "string"  }'
{  "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"  }}

List the app's badges GET

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.

Update a badge PATCH

Requires `COMMUNITY_BADGES_WRITE` and an app caller. Only the app's own badges; others are 404. `key` can't change.

key*string
Match^[a-z0-9][a-z0-9-]*$
Length1 <= length <= 48
name*string
Length1 <= length <= 40
description?string
Lengthlength <= 200
Default""
color*string
Match^#[0-9a-fA-F]{6}$