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

Award a badge to a member

Requires `COMMUNITY_BADGES_WRITE` and an app caller. Safe to repeat: an existing award keeps its `awardedAt` and sends no event. A new award emits `community.badge.awarded`. The member must be `ACTIVE`.

PUT
/community/members/{memberId}/badges/{badgeId}

Requires COMMUNITY_BADGES_WRITE and an app caller. Safe to repeat: an existing award keeps its awardedAt and sends no event. A new award emits community.badge.awarded. The member must be ACTIVE.

Authorization

x-api-key<token>

In: header

Path Parameters

memberId*string

Community membership id

badgeId*string

Response Body

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/community/members/string/badges/string"
{  "data": {    "id": "string",    "appId": "string",    "key": "string",    "name": "string",    "description": "string",    "color": "string",    "iconUrl": "string",    "awardedAt": "2019-08-24T14:15:22Z"  }}

Revoke a badge from a member DELETE

Requires `COMMUNITY_BADGES_WRITE` and an app caller. Safe to repeat. Removing an existing award emits `community.badge.revoked`. Works for members in any status.

Send a notification to members POST

Requires `COMMUNITY_NOTIFICATIONS_WRITE` and an app caller (`pwa_` secret); workspace API keys get 403. Sends an in-app notification and a push notification to up to 100 members. It never sends email. The title is always the app's name: Planeward sets it, and a `title` in the body is ignored. `href` is a path in the app. Opening the notification opens the app's channel on the community site with the app loaded at that path. Members can turn off an app's notifications. A member who did is still listed in `accepted`, so the app can't tell who muted it. A member gets at most 10 notifications an hour from one app; past that the member is skipped with `over_limit`. Send `key` when you retry: a member the app already sent that `key` in the last 24 hours is listed in `accepted` and not notified again. Without `key`, a retry notifies again. The response is 200 even when every member is skipped.