Get a run's timeline

GET

/projects/:projectId/playbook-runs/:runId/timeline

GET

/projects/:projectId/playbook-runs/:runId/timeline

1 curl https:/https://api/projects/projectId/playbook-runs/runId/timeline \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json"

1 {
2   "events": [
3     {
4       "id": "evt_9f8a7b6c",
5       "timestamp": "2024-06-10T15:42:30Z",
6       "type": "task_completed",
7       "details": {
8         "taskId": "task_12345",
9         "taskName": "Deploy to staging",
10         "completedBy": "alice@example.com",
11         "status": "success"
12       }
13     },
14     {
15       "id": "evt_8e7d6c5b",
16       "timestamp": "2024-06-10T15:30:00Z",
17       "type": "comment_added",
18       "details": {
19         "commentId": "cmt_98765",
20         "author": "bob@example.com",
21         "content": "Deployment started, monitoring logs."
22       }
23     },
24     {
25       "id": "evt_7d6c5b4a",
26       "timestamp": "2024-06-10T15:00:00Z",
27       "type": "run_started",
28       "details": {
29         "initiatedBy": "carol@example.com",
30         "runId": "run_abc123",
31         "playbookVersion": "v2.3.1"
32       }
33     }
34   ]
35 }

Returns the run’s timeline events (most recent first).

Authentication

AuthorizationBearer

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

Path parameters

projectIdstringRequired

runIdstringRequired

Query parameters

limitintegerOptional

Response

The run timeline.

Errors

401

Unauthorized Error

404

Not Found Error