Skip to main content
Notification tray items include string fields that identify what happened and what kind of tray item was produced. Use these fields for routing, icons, grouping, and display decisions in your app.
Do not hardcode notification message-template behavior from this page. The SDK returns text and templatedText on each tray item. Render those fields or map action/category values only for UI behavior you own, such as icons and routing.

​
Core Fields

​
Action Types

The TypeScript SDK type surface defines these action values. iOS and Android expose action type as a string on each returned tray item.

​
Tray Item Categories

The TypeScript SDK type surface defines these category values. iOS and Android expose the category as a string on each returned tray item.

​
Routing Guidance

  • Use targetType and targetId for the primary destination.
  • Use referenceType and referenceId when your UI needs to highlight a related post, comment, event, or other referenced object.
  • Use rootId and latestCommentId when they are present and your comment UI needs to open a thread context.
  • For actionType == "event" items, resolve the event id from actionReferenceId and route to the event detail page. When trayItemCategory == "event_created", the hydrated event object (including event.targetCommunity) is available on the item for rendering the community avatar, event-type chip (In-person / Virtual from event.type), and event start date/time (from event.startTime).
  • Prefer the returned text or templatedText for display copy instead of rebuilding notification copy in the client.

Notification Items

Query tray items and inspect returned fields

Tray Status

Observe and update tray-level seen status