Inbox items
An Inbox Item is one entry of a recipient's in-app feed.
An Inbox Item is one entry of a recipient's in-app feed. Clients receive it live over an Events Realtime Channel and page it here.
Service Sylphx Notify · Resource type notify.sylphx.com/InboxItem · Name pattern orgs/{org}/projects/{project}/envs/{env}/recipients/{recipient}/inbox_items/{inbox_item} · Shape record
Fields
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/recipients/{recipient}/inbox_items/{inbox_item}. |
uid | string | ibx_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
message | string | The Message that produced it. Output only. |
title | string | The rendered title. Output only. |
body | string | The rendered body. Output only. |
action_uri | string | Where the item links. Output only. |
state | InboxItemState | Read, unread, or archived. Output only. One of unread, read, archived. |
Methods
Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.
| Method | Call | What it does |
|---|---|---|
GET | get | Gets an inbox item. |
GET | list | Lists inbox items. |
POST | mark_read | Marks an inbox item read. |
POST | mark_unread | Marks an inbox item unread. |
POST | archive | Archives an inbox item. |
get
Gets an inbox item.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/recipients/recipient/inbox_items/inbox-item · scope notify:read · effect read · Request, response and examples
list
Lists inbox items.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/recipients/recipient/inbox_items · scope notify:read · effect read · paginated · Request, response and examples
mark_read
Marks an inbox item read.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/recipients/recipient/inbox_items/inbox-item:markRead · scope notify:write · effect write · Request, response and examples
mark_unread
Marks an inbox item unread.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/recipients/recipient/inbox_items/inbox-item:markUnread · scope notify:write · effect write · Request, response and examples
archive
Archives an inbox item.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/recipients/recipient/inbox_items/inbox-item:archive · scope notify:write · effect write · Request, response and examples