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

Send a notification to members

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.

POST
/community/notifications

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.

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/notifications" \  -H "Content-Type: application/json" \  -d '{    "memberIds": [      "string"    ],    "body": "string",    "href": "string"  }'
{  "data": {    "accepted": [      "string"    ],    "skipped": [      {        "memberId": "string",        "reason": "member_not_found"      }    ]  }}

Award a badge to a member PUT

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`.

List sites GET

Next Page

memberIds*array<>

Community membership ids. A repeated id is notified once and appears once in the response.

Items1 <= items <= 100
body*string

Plain text, shown as written. Markdown and HTML are not rendered.

Length1 <= length <= 280
href*string

Path in the app with an optional query, such as /orders/123. It is resolved against the origin of the app's Experience URL, so / is the root of that origin. It can't name a host or scheme, and can't contain a # fragment, \, spaces, non-ASCII characters or . and .. segments.

Match^(?![^?]*/(?:\.|%2[Ee]){1,2}(?:[/?]|$))/(?!/)(?:[A-Za-z0-9\-._~!$&'()*+,;=:@/?]|%[0-9A-Fa-f]{2})*$
Lengthlength <= 512
key?string

Makes a retry safe. A member the app already sent this key in the last 24 hours is listed in accepted and not notified again.

Match^[A-Za-z0-9._:-]+$
Length1 <= length <= 100