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.
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.
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" } ] }}
Planeward Docs