RelayAPI

Create a WebSocket ticket

Issues a single-use, short-lived ticket for an authenticated WebSocket upgrade. Pass the returned protocol as a WebSocket subprotocol; never put the ticket in a URL.

GET
/v1/ws-ticket
AuthorizationBearer <token>

API key (rlay_live_* or rlay_test_). Invite redemption also accepts a server-derived rlay_session_ bearer for a current user session.

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/ws-ticket"
{  "expires_at": "2019-08-24T14:15:22Z",  "protocol": "string",  "ticket": "stringstringstringstringstringst",  "ws_url": "string"}

Found something wrong? Help us improve this page.