Mint a thread WebSocket ticket

POST

/projects/:projectId/threads/:threadId/ws-ticket

Mints a short-lived signed ticket to authenticate the thread’s realtime WebSocket upgrade. Requires read access to the anchored entity; an inaccessible project or entity reads as 404.

Authentication

AuthorizationBearer

WorkOS session JWT or an organization API key, sent as Authorization: Bearer <token>.

Path parameters

projectIdstringRequired

threadIdstringRequired

Response

The signed WebSocket-upgrade ticket.

ticketstring

Opaque signed ticket; pass as ?ticket= on the WebSocket upgrade.

expiresAtstring

ISO-8601 expiry of the ticket.

expiresInSecondsdouble

Seconds until the ticket expires.

wsUrlstring

WebSocket URL with the ticket pre-applied.

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

1	curl -X POST https:/https://api/projects/projectId/threads/threadId/ws-ticket \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{}'

1	{
2	"ticket": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0aHJlYWQiOiI1ZjY3Y2QxMi1hYmNkLWU0ZjMtYmYxMi1hYmNkZWYxMjM0NTYiLCJleHAiOjE2ODk0MjQ4MDB9.4f7a8b9c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a",
3	"expiresAt": "2024-06-15T18:30:00Z",
4	"expiresInSeconds": 300,
5	"wsUrl": "wss://realtime.raker.one/ws?ticket=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0aHJlYWQiOiI1ZjY3Y2QxMi1hYmNkLWU0ZjMtYmYxMi1hYmNkZWYxMjM0NTYiLCJleHAiOjE2ODk0MjQ4MDB9.4f7a8b9c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a"
6	}