Skip to content

feat(web-api): add session_status to chat.stopStream arguments - #2708

Draft
zimeg wants to merge 3 commits into
mainfrom
clack/chat-stopstream-session-status
Draft

feat(web-api): add session_status to chat.stopStream arguments#2708
zimeg wants to merge 3 commits into
mainfrom
clack/chat-stopstream-session-status

Conversation

@zimeg

@zimeg zimeg commented Aug 21, 2026

Copy link
Copy Markdown
Member

Adds the optional session_status argument to chat.stopStream. When stopping a stream, an app can set the agent session's lifecycle status in the same call instead of a separate agents.sessions.setStatus.

  • session_status?: string — the agent session lifecycle status to set after stopping the stream; defaults to active. Acceptable values: active, processing, suspended, closed (the shared agent-session status enum).

Because stop() on the chatStream() helper is typed by ChatStopStreamArguments, this makes session_status type-safe via streamer.stop({ session_status }) as well as a direct client.chat.stopStream(...) call.

Verified

  • tsc --noEmit — clean
  • biome check — clean
  • Exercised end-to-end in a Bolt agent app: streamer.stop({ session_status }) sets the session status on stop as expected.

Notes

Companion to the agent sessions work (agents.sessions.* methods #2703, events #2707). Draft — intended to land in the same release window, timed at/after the argument is published in the public method reference. Java + Python equivalents to follow.

🤖 Generated with Claude Code

@changeset-bot

changeset-bot Bot commented Aug 21, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 1e342d8

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@slack/web-api Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@zimeg zimeg added enhancement M-T: A feature request for new functionality pkg:web-api applies to `@slack/web-api` semver:minor labels Aug 21, 2026
@zimeg zimeg self-assigned this Aug 21, 2026
@codecov

codecov Bot commented Aug 21, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.15%. Comparing base (4322e14) to head (1e342d8).
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2708   +/-   ##
=======================================
  Coverage   89.15%   89.15%           
=======================================
  Files          65       65           
  Lines       10383    10383           
  Branches      473      473           
=======================================
  Hits         9257     9257           
  Misses       1095     1095           
  Partials       31       31           
Flag Coverage Δ
cli-hooks 89.15% <ø> (ø)
cli-test 89.15% <ø> (ø)
logger 89.15% <ø> (ø)
oauth 89.15% <ø> (ø)
socket-mode 89.15% <ø> (ø)
web-api 89.15% <ø> (ø)
webhook 89.15% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

zimeg and others added 3 commits August 21, 2026 17:23
chat.stopStream accepts an optional session_status to set the agent
session's lifecycle status when the stream is stopped (defaults to
active). Flows through the chatStream().stop() helper automatically.

Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
Match the canonical wording: "The session status to set after stopping
the stream. Defaults to active."

Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
@zimeg
zimeg force-pushed the clack/chat-stopstream-session-status branch from 716ff9c to 1e342d8 Compare August 22, 2026 00:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement M-T: A feature request for new functionality pkg:web-api applies to `@slack/web-api` semver:minor

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant