Mint a run WebSocket ticket

POST

/projects/:projectId/playbook-runs/:runId/ws-ticket

POST

/projects/:projectId/playbook-runs/:runId/ws-ticket

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

1 {
2   "ticket": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyb3VuSWQiOiI1ZjY3Y2Q4MC1hY2YxLTQ3NzktYmYxMy1kYjYxYjYzYjYxYjYiLCJleHAiOjE2ODk0MjQ4MDB9.4f7X9vJ9Xq3vZx7v9vX9vJ9Xq3vZx7v9vX9vJ9Xq3vZx7v9vX9vJ9Xq3vZx7v9v",
3   "expiresAt": "2024-06-15T12:00:00Z",
4   "expiresInSeconds": 300,
5   "wsUrl": "wss://app.raker.one/api/projects/123e4567-e89b-12d3-a456-426614174000/playbook-runs/5f67cd80-acf1-4779-bf13-db61b63b61b6/ws?ticket=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyb3VuSWQiOiI1ZjY3Y2Q4MC1hY2YxLTQ3NzktYmYxMy1kYjYxYjYzYjYxYjYiLCJleHAiOjE2ODk0MjQ4MDB9.4f7X9vJ9Xq3vZx7v9vX9vJ9Xq3vZx7v9vX9vJ9Xq3vZx7v9vX9vJ9Xq3vZx7v9v"
6 }

Mints a short-lived signed ticket to authenticate the run’s WebSocket upgrade.

Authentication

AuthorizationBearer

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

Path parameters

projectIdstringRequired

runIdstringRequired

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

404

Not Found Error