Notification types
inviteAccept
Fired when an invitation is accepted.
Delivered as the
notification socket event with type set to inviteAccept.Fired when an invitation is accepted.
Payload for the inviteAccept event.
Token keys marked with (*) will be deprecated in a future release and should not be used for new development; replace them with the values and objects in the changes key in existing implementations.
Payload
| Property | Type | Required | Description |
|---|---|---|---|
type | string | yes | The specific type of notification event (matches the top-level key, e.g., 'workspaceCreate'). Every notification type is documented as its own event in this reference. |
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 | |
changes | object | no |
tokens
| Property | Type | Required | Description |
|---|---|---|---|
(*)requesterId | string (uuid) | no | Deprecated. Use initiatorId. |
(*)requester | object | no | Deprecated. Use initiator. |
(*)resourceType | string | no | Deprecated. |
(*)resourceId | string (uuid) | no | Deprecated. |
(*)role | string | no | Deprecated. |
(*)invite | object | no | Deprecated. The invite object that was accepted. |
(*)membership | object | no | Deprecated. The newly created membership object. |
changes
| Property | Type | Required | Description |
|---|---|---|---|
update | object | object[] | no |
update (items)
One of 2 variants:
Variant 1
| Property | Type | Required | Description |
|---|---|---|---|
resourceId | string (uuid) | no | Note: the ID of the resource the membership belongs to (not the membership ID). |
resourceType | "membership" | no | |
resource | object | no | The membership created by accepting the invite. |
Variant 2
| Property | Type | Required | Description |
|---|---|---|---|
resourceId | string (uuid) | no | Note: the ID of the resource the invite belongs to (not the invite ID). |
resourceType | "invite" | no | |
resource | object | no | The accepted invite. |