Access API
Vault+ API
Realtime
{
"connection": {
"id": "conn_oy6c6kim3uo0cyiu3iy67m4d",
"clientReferenceId": "user_456"
},
"environment": "live",
"receivedAt": "2026-04-23T14:30:15.209952452Z",
"messageType": "text",
"payloadKey": "of.websocket.event.received|chat_messages,count_priority_chat,unread_tips",
"shapeSubtype": "chat.inbox.counts_updated",
"truncated": false,
"json": {
"chat_messages": 25,
"count_priority_chat": 25,
"unread_tips": 0
},
"rawText": "{\"chat_messages\":25,\"count_priority_chat\":25,\"unread_tips\":0}"
}Beta
Inbox Counts
Schema for inbox counter updates delivered through the Realtime beta webhook
This schema documents the
of.websocket.event.received|chat_messages,count_priority_chat,unread_tips payload family.A structured websocket payload with inbox and priority chat counters.
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|chat_messages,count_priority_chat,unread_tips Whether OFAuth truncated the upstream payload before forwarding it.
Show child attributes
Show child attributes
Example:
{
"chat_messages": 25,
"count_priority_chat": 25,
"unread_tips": 0
}Curated subtype label for this payload family.
Available options:
chat.inbox.counts_updated, 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