Realtime · Schema

Realtime Presence

A presence record describing a member's membership in a realtime channel — who is connected, with what client metadata, and from when. Generalizes the presence models in Ably, Pusher, PubNub, Phoenix Presence, and LiveKit room participants.

RealtimeWebSocketWebRTCServer-Sent EventsMQTTPush NotificationsPub SubPresenceSignalingTopic

Properties

Name	Type	Description
channel	string	Channel on which the presence event occurred.
clientId	string	Identifier of the user or client whose presence is being reported.
connectionId	string	Provider-assigned identifier for the transport connection backing this presence.
action	string	The presence transition this record represents.
data	object	Application-defined presence metadata associated with the member (e.g., display name, avatar URL, status, location).
since	string	Time at which the member entered the channel (only for 'present'/'update').
occurredAt	string	Time the presence event occurred.

View JSON Schema on GitHub

JSON Schema

{
  "$id": "realtime-presence.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Realtime Presence",
  "description": "A presence record describing a member's membership in a realtime channel — who is connected, with what client metadata, and from when. Generalizes the presence models in Ably, Pusher, PubNub, Phoenix Presence, and LiveKit room participants.",
  "type": "object",
  "required": [
    "channel",
    "clientId",
    "action"
  ],
  "properties": {
    "channel": {
      "type": "string",
      "description": "Channel on which the presence event occurred."
    },
    "clientId": {
      "type": "string",
      "description": "Identifier of the user or client whose presence is being reported."
    },
    "connectionId": {
      "type": "string",
      "description": "Provider-assigned identifier for the transport connection backing this presence."
    },
    "action": {
      "type": "string",
      "description": "The presence transition this record represents.",
      "enum": [
        "enter",
        "leave",
        "update",
        "present",
        "absent"
      ]
    },
    "data": {
      "type": "object",
      "description": "Application-defined presence metadata associated with the member (e.g., display name, avatar URL, status, location).",
      "additionalProperties": true
    },
    "since": {
      "type": "string",
      "format": "date-time",
      "description": "Time at which the member entered the channel (only for 'present'/'update')."
    },
    "occurredAt": {
      "type": "string",
      "format": "date-time",
      "description": "Time the presence event occurred."
    }
  },
  "additionalProperties": false
}