Skip to content
XOS Developers

notifications

Platform module · 5 operations

List notification rows

GET/notifications

A notification for the caller. Returns a cursor page of notification rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

Get a notification

GET/notifications/{id}

A notification for the caller. Returns one notification with its `ETag`. A notification the caller may not see returns 404.

Update a notification

PATCH/notifications/{id}

A notification for the caller. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

Mark all notifications read

POST/notifications/mark-all-read

Marks every unread notification of the caller as read. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

Act on a notification

POST/notifications/{id}/act

Acts where the notification arrived, without opening its record (app.act_on_notification): approve or reject the approval an approval request asks for (app.decide_approval decides every rule; a rejection needs a comment), or mark it Done. Only the recipient acts. Push notification action buttons call this operation. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.