Start a playbook run

POST

/projects/:projectId/playbook-runs

Starts a new run of a project-scoped playbook and returns the live run plus a WebSocket-upgrade ticket.

AuthorizationBearer

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

projectIdstringRequired

This endpoint expects an object.

playbookIdstringRequired>=1 character

startDatamap from strings to anyOptionalDefaults to {}

taskAssignmentsmap from strings to stringsOptionalDefaults to {}

attachedFileIdslist of stringsOptionalDefaults to []

The newly started run.

runmap from strings to any

A playbook run projection.

wsTicketstring

Signed ticket for the run's WebSocket upgrade.

wsUrlstring

WebSocket URL with the ticket pre-applied.

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

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

1	{
2	"run": {},
3	"wsTicket": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJydW5JZCI6InJ1bl8xMjM0NTYiLCJleHAiOjE2ODU0MjQ4MDB9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
4	"wsUrl": "wss://app.raker.one/api/ws/playbook-runs/run_123456?ticket=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJydW5JZCI6InJ1bl8xMjM0NTYiLCJleHAiOjE2ODU0MjQ4MDB9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
5	}