Skip to content

Commit 067d35f

Browse files
Kasper Jungeclaude
authored andcommitted
docs: fix WebSocket event field names so API consumers use the correct keys
The check_passed/check_failed events documented `check_name` but the engine emits `name`; also added the missing `passed` field, the `error` reason for run_stopped, and the optional `traceback` field on log_message. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 779407b commit 067d35f

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

docs/dashboard.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -400,7 +400,7 @@ Every event has `type`, `run_id`, `timestamp`, and `data`. The table below lists
400400
| Event type | When | Data fields |
401401
|---|---|---|
402402
| `run_started` | Run begins | `checks`, `contexts`, `instructions` (int counts), `max_iterations`, `timeout`, `delay`, `prompt_name` |
403-
| `run_stopped` | Run ends for any reason | `reason` (`"completed"`, `"user_requested"`), `total`, `completed`, `failed`, `timed_out` |
403+
| `run_stopped` | Run ends for any reason | `reason` (`"completed"`, `"user_requested"`, `"error"`), `total`, `completed`, `failed`, `timed_out` |
404404
| `run_paused` | Run is paused ||
405405
| `run_resumed` | Run is resumed ||
406406

@@ -418,8 +418,8 @@ Every event has `type`, `run_id`, `timestamp`, and `data`. The table below lists
418418
| Event type | When | Data fields |
419419
|---|---|---|
420420
| `checks_started` | Check phase begins | `iteration`, `count` |
421-
| `check_passed` | A single check passes | `iteration`, `check_name`, `exit_code`, `timed_out` |
422-
| `check_failed` | A single check fails | `iteration`, `check_name`, `exit_code`, `timed_out` |
421+
| `check_passed` | A single check passes | `iteration`, `name`, `passed`, `exit_code`, `timed_out` |
422+
| `check_failed` | A single check fails | `iteration`, `name`, `passed`, `exit_code`, `timed_out` |
423423
| `checks_completed` | All checks finish | `iteration`, `passed`, `failed`, `results` (array of `{name, passed, exit_code, timed_out}`) |
424424

425425
**Prompt assembly**
@@ -435,4 +435,4 @@ Every event has `type`, `run_id`, `timestamp`, and `data`. The table below lists
435435
|---|---|---|
436436
| `primitives_reloaded` | Primitives re-discovered mid-run | `checks`, `contexts`, `instructions` (int counts) |
437437
| `settings_changed` | Reserved for future use ||
438-
| `log_message` | General log from the engine | `message`, `level` (`"info"`, `"error"`) |
438+
| `log_message` | General log from the engine | `message`, `level` (`"info"`, `"error"`), `traceback` (optional, present on crashes) |

0 commit comments

Comments
 (0)