Messaging

POST /v2/messaging/ws/tickets

Mints an opaque one-time Messaging WebSocket ticket that expires after 45 seconds. Offer ticket_protocol as a WebSocket subprotocol; never place it in a URL.

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/tickets
  • Auth
    HTTP bearer

Headers

X-Arbital-Position-Snapshot-Version'1' | '2'

Maximum position snapshot version understood by this client. Omitted or 1 returns an exact v1 projection; 2 exposes stored v2 fields. Stored v1 is never promoted. Does not change the stored snapshot or write version. Unsupported values are rejected before mutation.

Response

One-time Messaging WebSocket ticket

expires_at_unixinteger required
protocol'arbital.messaging.v1' required
ticket_protocolstring required
websocket_path'/v2/messaging/ws?version=1' | '/v2/messaging/ws?version=1&position_snapshot_version=2' required

Changes

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