Notifications API
Notifications
GET /me/notification-prefs
Per-kind notification channels.
Responses
200- OK. NotificationPrefs
application/json
PUT /me/notification-prefs
Replaces per-kind notification channels.
Request body
application/json, NotificationPrefs.
| Field | Type | Description |
|---|---|---|
kinds required | KindPref[] | Per-kind channels; kinds not listed use in-app and push. |
Responses
200- OK. NotificationPrefs
application/json
POST /me/push-subscriptions
Registers a device for Web Push.
Request body
application/json, NewPushSubscription.
| Field | Type | Description |
|---|---|---|
endpoint required | string | The push service endpoint. |
keys required | PushKeys | The subscription keys. |
Responses
201- Created. PushSubscription
application/json
DELETE /me/push-subscriptions/{id}
Removes a push subscription.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
id required | path | string (uuid) | The subscription |
Responses
204- No content
GET /orgs/{org}/notifications
Your notifications, newest first. Ones deferred by quiet hours or a hidden hat appear once they're due. Confirmation questions appear only while their confirmation is pending and unexpired.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
org required | path | string | The org slug. |
unread | query | boolean | Only unread. |
limit | query | integer (int32) | Page size. |
cursor | query | string | Cursor. |
Responses
200- OK. Paged_NotificationView
application/json
POST /orgs/{org}/notifications/read
Marks notifications read.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
org required | path | string | The org slug. |
Request body
application/json, MarkRead.
| Field | Type | Description |
|---|---|---|
all | boolean | Or every notification. |
ids | string (uuid)[] | These notifications. |
Responses
200- OK. Marked
application/json