notifications

Send E2E encrypted messages to one or more users.

Each message is encrypted with the recipient's individual shared key. Creates bilateral notifications visible to both sender and recipient. If recipient is online via WebSocket, delivers in real-time.

Returns the created notifications.

post/api/notifications/

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

Request body

Response

Successful Response

type'user_message' | 'workspaceuser_added_owner' | 'workspaceuser_added_collaborator' | 'workspaceuser_added_guest' | 'workspaceuser_removed' | 'workspaceuser_updated_owner' | 'workspaceuser_updated_collaborator' | 'workspaceuser_updated_guest' | 'contact_accepted' required

Notification types - all persisted AND delivered via WebSocket.

Type is self-descriptive, no need to parse content field.

external_idstring required
workspace_ext_idstring nullable
contentstring nullable
newboolean
created_atstring date-time required
updated_atstring date-time required

Changes

    • warning

      added the new contact_accepted enum value to the / response property for the response status

    • warning

      added the new user_message enum value to the / response property for the response status

    • warning

      added the new workspaceuser_added_collaborator enum value to the / response property for the response status

    • warning

      added the new workspaceuser_added_guest enum value to the / response property for the response status

    • warning

      added the new workspaceuser_added_owner enum value to the / response property for the response status

    • warning

      added the new workspaceuser_removed enum value to the / response property for the response status

    • warning

      added the new workspaceuser_updated_collaborator enum value to the / response property for the response status

    • warning

      added the new workspaceuser_updated_guest enum value to the / response property for the response status

    • warning

      added the new workspaceuser_updated_owner enum value to the / response property for the response status

    • info

      endpoint added