Access API
Vault+ API
Realtime
{
"connection": {
"id": "conn_oy6c6kim3uo0cyiu3iy67m4d",
"clientReferenceId": "user_456"
},
"environment": "live",
"receivedAt": "2026-04-23T14:30:15.143911227Z",
"messageType": "text",
"payloadKey": "of.websocket.event.received|api2_chat_message",
"shapeSubtype": "chat.message.created.live",
"truncated": false,
"json": {
"api2_chat_message": {
"id": 9372017685098,
"queueId": 39092614938,
"responseType": "message",
"text": "<p>test197</p>",
"price": 0,
"isFree": true,
"isTip": false,
"isNew": true,
"isOpened": false,
"isFromQueue": false,
"isMediaReady": true,
"mediaCount": 0,
"createdAt": "2026-04-23T14:30:14+00:00",
"changedAt": "2026-04-23T14:30:14+00:00",
"cancelSeconds": 120,
"fromUser": {
"id": 562630475,
"name": "Jose Rana",
"username": "jose.rana",
"isVerified": false
},
"media": [],
"previews": []
}
},
"rawText": "{\"api2_chat_message\":{\"id\":9372017685098}}"
}Beta
Chat Message
Schema for live chat message payloads delivered through the Realtime beta webhook
This schema documents the
of.websocket.event.received|api2_chat_message payload family.A live upstream chat message envelope from the OnlyFans websocket stream.
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|api2_chat_message Whether OFAuth truncated the upstream payload before forwarding it.
Show child attributes
Show child attributes
Example:
{
"api2_chat_message": {
"id": 9372017685098,
"queueId": 39092614938,
"responseType": "message",
"text": "<p>test197</p>",
"price": 0,
"isFree": true,
"isTip": false,
"isNew": true,
"isOpened": false,
"isFromQueue": false,
"isMediaReady": true,
"mediaCount": 0,
"createdAt": "2026-04-23T14:30:14+00:00",
"changedAt": "2026-04-23T14:30:14+00:00",
"cancelSeconds": 120,
"fromUser": {
"id": 562630475,
"name": "Jose Rana",
"username": "jose.rana",
"isVerified": false,
"lastSeen": "2026-04-23T14:30:14+00:00"
},
"media": [],
"previews": []
}
}
Curated subtype label for this payload family.
Available options:
chat.message.created.live, 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