Notification types
userFeed
Fired when an item in someone's user feed changes — a card placed or moved, an action item recorded, settled, removed or cleared.
Delivered as the
notification socket event with type set to userFeed.Fired when an item in someone's user feed changes — a card placed or moved, an action item recorded, settled, removed or cleared.
Sent on the user/{userId} channel of every person the change affects, with one payload for all of them. It names the item by kind + subjectKey (unique within one person's feed) rather than by entry id. Clients apply it to what they hold and refetch GET /v1/users/feed for anything they don't; a missed event only delays the feed, since the next fetch is complete.
Payload for the userFeed event.
Payload
| Property | Type | Required | Description |
|---|---|---|---|
type | string | yes | The specific type of notification event (matches the top-level key, e.g., 'workspaceCreate'). Every value in notificationTemplates (config/notifications.js) is documented in this tag. |
initiatorId | string (uuid) | no | ID of the user or system that initiated the event. Null if initiatorType is 'system'. |
initiatorType | "user" | "system" | yes | Type of initiator (user or system). |
initiator | object | null | no | Populated initiator user object (if initiatorType is 'user'). |
resourceId | string (uuid) | yes | ID of the primary resource this notification pertains to. |
resourceType | string | yes | Type of the primary resource this notification pertains to. |
channels | string[] | no | The specific channels this notification was published on. Present on notification objects returned by the REST API only; the socket 'notification' payload omits it (and id). |
createdAt | string (date-time) | yes | Timestamp when the notification was created. |
tokens | object | no |
tokens
| Property | Type | Required | Description |
|---|---|---|---|
item | object | yes |
item
| Property | Type | Required | Description |
|---|---|---|---|
change | "placed" | "state" | "removed" | "cleared" | yes | placed — new, or moved to the top (lastActivityAt). state — its state changed. removed — it is gone. cleared — every open action item up to before was dismissed. |
category | "activity" | "action" | yes | |
kind | string | no | |
subjectKey | string | no | |
subjectKeys | string[] | no | In place of subjectKey when several items of one kind changed state at once. |
state | "open" | "done" | "dismissed" | no | |
feedEventId | string | no | The card, for activity items. |
projectId | string | no | |
visibility | string | no | |
lastActivityAt | integer (int64) | no | |
before | integer (int64) | no | For cleared. |