Skip to content

docs: replace removed session.idle.backgroundTasks field with the current aborted field #2232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SteveSandersonMS merged 1 commit into from
Aug 4, 2026
+4 −4
Merged

docs: replace removed session.idle.backgroundTasks field with the current aborted field #2232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/features/streaming-events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -548,7 +548,7 @@ Ephemeral. The agent has finished all processing and is ready for the next messa

| Data Field | Type | Required | Description |
|------------|------|----------|-------------|
| `backgroundTasks` | `BackgroundTasks` | | Background agents/shells still running when the agent became idle |
| `aborted` | `boolean` | | True when the preceding turn was cancelled via abort signal |

### `session.error`

Expand Down Expand Up @@ -958,7 +958,7 @@ This table lists key `data` payload fields. Common envelope fields are documente
| `tool.execution_partial_result` | ✅ | Tool | `toolCallId`, `partialOutput` |
| `tool.execution_progress` | ✅ | Tool | `toolCallId`, `progressMessage` |
| `tool.execution_complete` | | Tool | `toolCallId`, `success`, `result?`, `error?` |
| `session.idle` | ✅ | Session | `backgroundTasks?` |
| `session.idle` | ✅ | Session | `aborted?` |
| `session.error` | | Session | `errorType`, `message`, `statusCode?` |
| `session.compaction_start` | | Session | *(empty)* |
| `session.compaction_complete` | | Session | `success`, `preCompactionTokens?`, `summaryContent?` |
Expand Down
2 changes: 1 addition & 1 deletion nodejs/docs/agent-author.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -270,7 +270,7 @@ const unsub = session.on("tool.execution_complete", (event) => {
| `tool.execution_start` | `toolCallId`, `toolName`, `arguments` |
| `tool.execution_complete` | `toolCallId`, `toolName`, `success`, `result`, `error` |
| `user.message` | `content`, `attachments`, `source` |
| `session.idle` | `backgroundTasks` |
| `session.idle` | `aborted` |
| `session.error` | `errorType`, `message`, `stack` |
| `permission.requested` | `requestId`, `permissionRequest.kind` |
| `session.shutdown` | `shutdownType`, `totalPremiumRequests` |
Expand Down
2 changes: 1 addition & 1 deletion nodejs/docs/examples.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -419,7 +419,7 @@ session.on("assistant.message", (event) => {
| `tool.execution_start` | A tool is about to run | `toolCallId`, `toolName`, `arguments` |
| `tool.execution_complete` | A tool finished running | `toolCallId`, `toolName`, `success`, `result`, `error` |
| `user.message` | User sent a message | `content`, `attachments`, `source` |
| `session.idle` | Session finished processing a turn | `backgroundTasks` |
| `session.idle` | Session finished processing a turn | `aborted` |
| `session.error` | An error occurred | `errorType`, `message`, `stack` |
| `permission.requested` | Agent needs permission (shell, file write, etc.) | `requestId`, `permissionRequest.kind` |
| `session.shutdown` | Session is ending | `shutdownType`, `totalPremiumRequests`, `codeChanges` |
Expand Down
Loading