SPsparkvault
notify

List a recipient inbox

Changed on

The sender-side view of one recipient's notification list: your Notify inbox, which lists exactly the notifications delivered to them in_app. The row IS the in_app delivery: its ladder carries in_app, because the send named it or your config resolved it and the recipient left In-app on for your site (a security send crosses that switch), and it is listed when that step runs: as the send fans out when in_app leads the ladder, and only when the step comes due when it follows email. A notification whose ladder carries no in_app (a send naming email alone, a recipient who switched In-app off for your site on auth.sv on any send but a security one, one their own preferences or block refused, one no channel reaches), one whose in_app step has not delivered it (and never will once a stop ended its ladder first), and the per-recipient ceiling's skip are status records only: in no view, and a mark of one answers 404. Filtering happens after the page is read, so a short page with a live cursor means keep paging, not end of list. A notification past its send's history horizon is never listed. Each sealed row whose grant still opens carries the recipient's own pointer (sparklink_code and pointer_url), for the recipient's client to open, and a plaintext row its body: treat the answer as sensitive and keep it out of logs: on a sealed send at verification_level: "none" to a recipient addressed by id alone, the pointer opens the content, once, for whoever holds it.

get/products/notify/inbox

Request

Query parameters

recipient_idstring required

The recipient whose inbox to read. Read in the form a send keys its recipient by (trimmed, with an email address lowercased the way Identity stores it), so the id or address as the send named it reads the same inbox. A value that is blank once trimmed, longer than 256 UTF-8 bytes, or holding a control character or noncharacter names no inbox and is rejected 400.

state'all' | 'unseen' | 'unread' | 'archived'
limitinteger

A page-size hint: a value above 100 reads as 100, and a missing, zero, negative or non-numeric one as 50.

cursorstring

Continuation token from the previous page.

Response

A page of notifications.

Changes

  • a9a10e328ba5Revision changes
    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

  • 56d7c265a77aRevision changes
    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • warning

      removed the optional property /// from the response with the status