Access API
Vault+ API
Realtime
{
"connection": {
"id": "conn_oy6c6kim3uo0cyiu3iy67m4d",
"clientReferenceId": "user_456"
},
"environment": "live",
"receivedAt": "2026-04-19T11:31:53.219930536Z",
"messageType": "text",
"payloadKey": "of.websocket.event.received|hasSystemNotifications,new_message",
"shapeSubtype": "websocket.structured.multi-key",
"truncated": false,
"json": {
"hasSystemNotifications": true,
"new_message": {}
},
"rawText": "{\"hasSystemNotifications\":true,\"new_message\":{}}"
}Beta
System New Message
Schema for structured websocket payloads with hasSystemNotifications and new_message
This schema documents the
of.websocket.event.received|hasSystemNotifications,new_message payload family.A structured websocket payload carrying new_message and hasSystemNotifications.
Connection context for the source upstream websocket payload.
Show child attributes
Show child attributes
OFAuth environment for the source connection.
Available options:
live, test, sandbox When OFAuth received the upstream websocket payload.
Transport-level websocket frame classification from the relay.
Stable OFAuth shape key for this payload.
Available options:
of.websocket.event.received|hasSystemNotifications,new_message Whether OFAuth truncated the upstream payload before forwarding it.
Show child attributes
Show child attributes
Example:
{
"hasSystemNotifications": true,
"new_message": {}
}Curated subtype label for this payload family.
Available options:
websocket.structured.multi-key, null Raw upstream payload text, present when the frame was text-based.
Raw upstream payload bytes as base64 when the frame was binary.
Was this page helpful?
⌘I