Skip to main content
WSS
The AsyncAPI document defines incoming commands, outgoing events, and acknowledgement shapes. Its messages describe Socket.IO argument tuples; use a Socket.IO client to encode the transport packets.

Download the AsyncAPI contract

Download the generated event contract.
The schema is generated from runtime definitions and checked for drift. Behavioral tests separately check sequencing, replay, limits, and cleanup. See Start a session and Cursors and replay for those obligations.
projectApiKey
type:http

Enter your complete project API key (pho_sk_...) without the Bearer prefix. It is sent as Authorization: Bearer <project API key>. The key must belong to the projectId in the connection URL.

headers
type:object
connection
type:string

Upgrade

upgrade
type:string

websocket

method
type:string

GET

query
type:object
reply
type:array
subscribe
type:array
delivery
type:array
delivery_error
type:array