> ## Documentation Index
> Fetch the complete documentation index at: https://learn.social.plus/llms.txt
> Use this file to discover all available pages before exploring further.

# Notification Event Fields

> Reference action and category values returned on notification tray items.

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.

<Warning>
  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.
</Warning>

## Core Fields

| Field              | TypeScript                     | iOS                            | Android                                  | Purpose                                                                              |
| ------------------ | ------------------------------ | ------------------------------ | ---------------------------------------- | ------------------------------------------------------------------------------------ |
| Action type        | `actionType`                   | `actionType`                   | `getActionType()`                        | Broad action family                                                                  |
| Tray item category | `trayItemCategory`             | `trayItemCategory`             | `getTrayItemCategory()`                  | More specific category for mentions, reactions, follows, events, and related actions |
| Target             | `targetId`, `targetType`       | `targetId`, `targetType`       | `getTargetId()`, `getTargetType()`       | Object the notification points at                                                    |
| Reference          | `referenceId`, `referenceType` | `referenceId`, `referenceType` | `getReferenceId()`, `getReferenceType()` | Related object, when present                                                         |
| Parent             | `parentId`                     | `parentId`                     | `getParentId()`                          | Parent object, when present                                                          |
| Rendered text      | `text`, `templatedText`        | `text`, `templatedText`        | `getText()`, `getTemplatedText()`        | Text returned by the backend for display                                             |

## 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.

| Value          | Meaning                                                      |
| -------------- | ------------------------------------------------------------ |
| `post`         | Post-related notification                                    |
| `poll`         | Poll-related notification                                    |
| `comment`      | Comment-related notification                                 |
| `reaction`     | Reaction-related notification                                |
| `mention`      | Mention-related notification                                 |
| `reply`        | Reply-related notification                                   |
| `join_request` | Join-request-related notification                            |
| `user`         | User-related notification                                    |
| `event`        | Event-related notification (routes to the event detail page) |

## 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.

| Value                     | Meaning                         |
| ------------------------- | ------------------------------- |
| `mention_in_post`         | Mention in a post               |
| `mention_in_comment`      | Mention in a comment            |
| `mention_in_reply`        | Mention in a reply              |
| `mention_in_poll`         | Mention in a poll               |
| `reaction_on_post`        | Reaction on a post              |
| `reaction_on_comment`     | Reaction on a comment           |
| `reaction_on_reply`       | Reaction on a reply             |
| `respond_on_join_request` | Response to a join request      |
| `follow`                  | Follow notification             |
| `event_reminder`          | Event reminder                  |
| `event_started`           | Event started notification      |
| `event_created`           | Event created notification      |
| `room_cohost_invite`      | Room co-host invitation         |
| `user_profile_reset`      | User profile reset notification |

## 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.

## Related Documentation

<CardGroup cols={2}>
  <Card title="Notification Items" href="./notification-items" icon="list">
    Query tray items and inspect returned fields
  </Card>

  <Card title="Tray Status" href="./notification-tray-status" icon="eye">
    Observe and update tray-level seen status
  </Card>
</CardGroup>
