notifications

WebSocket Message Schemas

Expose all WebSocket message types in the OpenAPI schema.

server_messages: Messages sent from server to client
client_messages: Messages sent from client to server

Frontend can autogenerate TypeScript types from OpenAPI schema components.

get/api/notifications/ws-schemas

Response

Successful Response

Changes

Changed in 8 of the 34 revisions of this API.1169

Jan 20, 2026ec6f2761328041See the full diff
- ●
  added the new analysing enum value to the server_messages/items/anyOf[subschema #5: TaskUpdateMessage]/status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new encrypting enum value to the server_messages/items/anyOf[subschema #5: TaskUpdateMessage]/status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new indexing enum value to the server_messages/items/anyOf[subschema #5: TaskUpdateMessage]/status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new parsing enum value to the server_messages/items/anyOf[subschema #5: TaskUpdateMessage]/status response property for the response status 200
  response-property-enum-value-added
- ○
  removed the processing enum value from the server_messages/items/anyOf[subschema #5: TaskUpdateMessage]/status response property for the response status 200
  response-property-enum-value-removed
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jan 18, 20262869dee5e8ca1See the full diff
- ○
  added BatchCompleteMessage to the server_messages/items/ response property anyOf list for the response status 200
  response-property-any-of-added
Jan 17, 2026b91e4b449d56213See the full diff
- ▲
  the client_messages/items/ response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ▲
  removed the required property client_messages/items/token from the response with the 200 status
  response-required-property-removed
- ●
  removed the optional property client_messages/items/type from the response with the 200 status
  response-optional-property-removed
- ○
  added AuthMessage SendMessageRequest-Output to the client_messages/items/ response property anyOf list for the response status 200
  response-property-any-of-added
- ○
  added NotificationResponse to the server_messages/items/ response property anyOf list for the response status 200
  response-property-any-of-added
- ○
  removed UserMessageNotification WorkspaceShareNotification ContactAcceptedNotification from the server_messages/items/ response property anyOf list for the response status 200
  response-property-any-of-removed
This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jan 11, 2026c3c7930241701See the full diff
- ○
  removed the offline enum value from the server_messages/items/anyOf[subschema #3: PresenceUpdateMessage]/status response property for the response status 200
  response-property-enum-value-removed
Jan 1, 2026b9aa4615da161See the full diff
- ●
  added the new unknown enum value to the server_messages/items/anyOf[subschema #3: PresenceUpdateMessage]/status response property for the response status 200
  response-property-enum-value-added
Dec 31, 2025d14bca97ba8612See the full diff
- ▲
  the response's body type/format changed from array/ to object/ for status 200
  response-body-type-changed
- ○
  added the optional property client_messages to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property server_messages to the response with the 200 status
  response-optional-property-added
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Dec 19, 20257073d86523868See the full diff
- ▲
  the response's body type/format changed from object/ to array/ for status 200
  response-body-type-changed
- ▲
  removed the required property AuthResultMessage from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property ConnectionClosedMessage from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property ContactAcceptedMessage from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property NotificationMessage from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property PongMessage from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property TaskUpdateMessage from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property WorkspaceShareMessage from the response with the 200 status
  response-required-property-removed
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Dec 10, 202524f3127dab7f1See the full diff
- ○
  endpoint added
  endpoint-added

Full history