Messaging

GET /v2/messaging/ws

Upgrades to the authenticated Messaging event stream. Offer arbital.messaging.v1 and the ticket_protocol returned by POST /v2/messaging/ws/tickets as WebSocket subprotocols. Reconcile HTTP state after every connection or resync_required frame.

Request

  • Base URL
    https://api.arbital.xyz (the document declares no server; this is the origin it was published from)
  • URL
    https://api.arbital.xyz/v2/messaging/ws
  • Auth
    API key in header Sec-WebSocket-Protocol

Query parameters

version'1'
position_snapshot_version'1' | '2'

Maximum position snapshot version understood by this connection. Protocol version remains 1; stored v1 remains v1.

Changes

No recorded changes to this operation across all 1 revision of this API.