Skip to content

fix(web-client): update thread_ts to be required for chat_startStream #1753

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
Parent: feat: add ai-enabled features text streaming methods, feedback blocks, and loading state
merged 2 commits into from
Sep 30, 2025
Merged

fix(web-client): update thread_ts to be required for chat_startStream #1753

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c8dd10b
fix(web-client): update thread_ts arg to be required for chat_startSt…
mwbrooks Sep 29, 2025
fc9b73a
docs(web-client): generate docs
mwbrooks Sep 29, 2025
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
6 changes: 3 additions & 3 deletions docs/reference/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3004,7 +3004,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
self,
*,
channel: str,
thread_ts: Optional[str] = None,
thread_ts: str,
markdown_text: Optional[str] = None,
recipient_team_id: Optional[str] = None,
recipient_user_id: Optional[str] = None,
Expand Down Expand Up @@ -10268,7 +10268,7 @@ <h3>Methods</h3>
<a href="https://api.slack.com/methods/chat.scheduledMessages.list">https://api.slack.com/methods/chat.scheduledMessages.list</a></p></div>
</dd>
<dt id="slack_sdk.WebClient.chat_startStream"><code class="name flex">
<span>def <span class="ident">chat_startStream</span></span>(<span>self,<br>*,<br>channel: str,<br>thread_ts: str | None = None,<br>markdown_text: str | None = None,<br>recipient_team_id: str | None = None,<br>recipient_user_id: str | None = None,<br>unfurl_links: bool | None = None,<br>unfurl_media: bool | None = None,<br>**kwargs) ‑> <a title="slack_sdk.web.slack_response.SlackResponse" href="web/slack_response.html#slack_sdk.web.slack_response.SlackResponse">SlackResponse</a></span>
<span>def <span class="ident">chat_startStream</span></span>(<span>self,<br>*,<br>channel: str,<br>thread_ts: str,<br>markdown_text: str | None = None,<br>recipient_team_id: str | None = None,<br>recipient_user_id: str | None = None,<br>unfurl_links: bool | None = None,<br>unfurl_media: bool | None = None,<br>**kwargs) ‑> <a title="slack_sdk.web.slack_response.SlackResponse" href="web/slack_response.html#slack_sdk.web.slack_response.SlackResponse">SlackResponse</a></span>
</code></dt>
<dd>
<details class="source">
Expand All @@ -10279,7 +10279,7 @@ <h3>Methods</h3>
self,
*,
channel: str,
thread_ts: Optional[str] = None,
thread_ts: str,
markdown_text: Optional[str] = None,
recipient_team_id: Optional[str] = None,
recipient_user_id: Optional[str] = None,
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/oauth/installation_store/file/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="slack_sdk.oauth.installation_store.file.FileInstallationStore"><code class="flex name class">
<span>class <span class="ident">FileInstallationStore</span></span>
<span>(</span><span>*,<br>base_dir: str = '/Users/eden.zimbelman/.bolt-app-installation',<br>historical_data_enabled: bool = True,<br>client_id: str | None = None,<br>logger: logging.Logger = &lt;Logger slack_sdk.oauth.installation_store.file (WARNING)&gt;)</span>
<span>(</span><span>*,<br>base_dir: str = '/Users/michael.brooks/.bolt-app-installation',<br>historical_data_enabled: bool = True,<br>client_id: str | None = None,<br>logger: logging.Logger = &lt;Logger slack_sdk.oauth.installation_store.file (WARNING)&gt;)</span>
</code></dt>
<dd>
<details class="source">
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/oauth/installation_store/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -327,7 +327,7 @@ <h3>Methods</h3>
</dd>
<dt id="slack_sdk.oauth.installation_store.FileInstallationStore"><code class="flex name class">
<span>class <span class="ident">FileInstallationStore</span></span>
<span>(</span><span>*,<br>base_dir: str = '/Users/eden.zimbelman/.bolt-app-installation',<br>historical_data_enabled: bool = True,<br>client_id: str | None = None,<br>logger: logging.Logger = &lt;Logger slack_sdk.oauth.installation_store.file (WARNING)&gt;)</span>
<span>(</span><span>*,<br>base_dir: str = '/Users/michael.brooks/.bolt-app-installation',<br>historical_data_enabled: bool = True,<br>client_id: str | None = None,<br>logger: logging.Logger = &lt;Logger slack_sdk.oauth.installation_store.file (WARNING)&gt;)</span>
</code></dt>
<dd>
<details class="source">
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/oauth/state_store/file/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="slack_sdk.oauth.state_store.file.FileOAuthStateStore"><code class="flex name class">
<span>class <span class="ident">FileOAuthStateStore</span></span>
<span>(</span><span>*,<br>expiration_seconds: int,<br>base_dir: str = '/Users/eden.zimbelman/.bolt-app-oauth-state',<br>client_id: str | None = None,<br>logger: logging.Logger = &lt;Logger slack_sdk.oauth.state_store.file (WARNING)&gt;)</span>
<span>(</span><span>*,<br>expiration_seconds: int,<br>base_dir: str = '/Users/michael.brooks/.bolt-app-oauth-state',<br>client_id: str | None = None,<br>logger: logging.Logger = &lt;Logger slack_sdk.oauth.state_store.file (WARNING)&gt;)</span>
</code></dt>
<dd>
<details class="source">
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/oauth/state_store/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="slack_sdk.oauth.state_store.FileOAuthStateStore"><code class="flex name class">
<span>class <span class="ident">FileOAuthStateStore</span></span>
<span>(</span><span>*,<br>expiration_seconds: int,<br>base_dir: str = '/Users/eden.zimbelman/.bolt-app-oauth-state',<br>client_id: str | None = None,<br>logger: logging.Logger = &lt;Logger slack_sdk.oauth.state_store.file (WARNING)&gt;)</span>
<span>(</span><span>*,<br>expiration_seconds: int,<br>base_dir: str = '/Users/michael.brooks/.bolt-app-oauth-state',<br>client_id: str | None = None,<br>logger: logging.Logger = &lt;Logger slack_sdk.oauth.state_store.file (WARNING)&gt;)</span>
</code></dt>
<dd>
<details class="source">
Expand Down
6 changes: 3 additions & 3 deletions docs/reference/web/async_client.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2900,7 +2900,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
self,
*,
channel: str,
thread_ts: Optional[str] = None,
thread_ts: str,
markdown_text: Optional[str] = None,
recipient_team_id: Optional[str] = None,
recipient_user_id: Optional[str] = None,
Expand Down Expand Up @@ -10164,7 +10164,7 @@ <h3>Methods</h3>
<a href="https://api.slack.com/methods/chat.scheduledMessages.list">https://api.slack.com/methods/chat.scheduledMessages.list</a></p></div>
</dd>
<dt id="slack_sdk.web.async_client.AsyncWebClient.chat_startStream"><code class="name flex">
<span>async def <span class="ident">chat_startStream</span></span>(<span>self,<br>*,<br>channel: str,<br>thread_ts: str | None = None,<br>markdown_text: str | None = None,<br>recipient_team_id: str | None = None,<br>recipient_user_id: str | None = None,<br>unfurl_links: bool | None = None,<br>unfurl_media: bool | None = None,<br>**kwargs) ‑> <a title="slack_sdk.web.async_slack_response.AsyncSlackResponse" href="async_slack_response.html#slack_sdk.web.async_slack_response.AsyncSlackResponse">AsyncSlackResponse</a></span>
<span>async def <span class="ident">chat_startStream</span></span>(<span>self,<br>*,<br>channel: str,<br>thread_ts: str,<br>markdown_text: str | None = None,<br>recipient_team_id: str | None = None,<br>recipient_user_id: str | None = None,<br>unfurl_links: bool | None = None,<br>unfurl_media: bool | None = None,<br>**kwargs) ‑> <a title="slack_sdk.web.async_slack_response.AsyncSlackResponse" href="async_slack_response.html#slack_sdk.web.async_slack_response.AsyncSlackResponse">AsyncSlackResponse</a></span>
</code></dt>
<dd>
<details class="source">
Expand All @@ -10175,7 +10175,7 @@ <h3>Methods</h3>
self,
*,
channel: str,
thread_ts: Optional[str] = None,
thread_ts: str,
markdown_text: Optional[str] = None,
recipient_team_id: Optional[str] = None,
recipient_user_id: Optional[str] = None,
Expand Down
6 changes: 3 additions & 3 deletions docs/reference/web/client.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2900,7 +2900,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
self,
*,
channel: str,
thread_ts: Optional[str] = None,
thread_ts: str,
markdown_text: Optional[str] = None,
recipient_team_id: Optional[str] = None,
recipient_user_id: Optional[str] = None,
Expand Down Expand Up @@ -10164,7 +10164,7 @@ <h3>Methods</h3>
<a href="https://api.slack.com/methods/chat.scheduledMessages.list">https://api.slack.com/methods/chat.scheduledMessages.list</a></p></div>
</dd>
<dt id="slack_sdk.web.client.WebClient.chat_startStream"><code class="name flex">
<span>def <span class="ident">chat_startStream</span></span>(<span>self,<br>*,<br>channel: str,<br>thread_ts: str | None = None,<br>markdown_text: str | None = None,<br>recipient_team_id: str | None = None,<br>recipient_user_id: str | None = None,<br>unfurl_links: bool | None = None,<br>unfurl_media: bool | None = None,<br>**kwargs) ‑> <a title="slack_sdk.web.slack_response.SlackResponse" href="slack_response.html#slack_sdk.web.slack_response.SlackResponse">SlackResponse</a></span>
<span>def <span class="ident">chat_startStream</span></span>(<span>self,<br>*,<br>channel: str,<br>thread_ts: str,<br>markdown_text: str | None = None,<br>recipient_team_id: str | None = None,<br>recipient_user_id: str | None = None,<br>unfurl_links: bool | None = None,<br>unfurl_media: bool | None = None,<br>**kwargs) ‑> <a title="slack_sdk.web.slack_response.SlackResponse" href="slack_response.html#slack_sdk.web.slack_response.SlackResponse">SlackResponse</a></span>
</code></dt>
<dd>
<details class="source">
Expand All @@ -10175,7 +10175,7 @@ <h3>Methods</h3>
self,
*,
channel: str,
thread_ts: Optional[str] = None,
thread_ts: str,
markdown_text: Optional[str] = None,
recipient_team_id: Optional[str] = None,
recipient_user_id: Optional[str] = None,
Expand Down
6 changes: 3 additions & 3 deletions docs/reference/web/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3261,7 +3261,7 @@ <h2 id="raises">Raises</h2>
self,
*,
channel: str,
thread_ts: Optional[str] = None,
thread_ts: str,
markdown_text: Optional[str] = None,
recipient_team_id: Optional[str] = None,
recipient_user_id: Optional[str] = None,
Expand Down Expand Up @@ -10525,7 +10525,7 @@ <h3>Methods</h3>
<a href="https://api.slack.com/methods/chat.scheduledMessages.list">https://api.slack.com/methods/chat.scheduledMessages.list</a></p></div>
</dd>
<dt id="slack_sdk.web.WebClient.chat_startStream"><code class="name flex">
<span>def <span class="ident">chat_startStream</span></span>(<span>self,<br>*,<br>channel: str,<br>thread_ts: str | None = None,<br>markdown_text: str | None = None,<br>recipient_team_id: str | None = None,<br>recipient_user_id: str | None = None,<br>unfurl_links: bool | None = None,<br>unfurl_media: bool | None = None,<br>**kwargs) ‑> <a title="slack_sdk.web.slack_response.SlackResponse" href="slack_response.html#slack_sdk.web.slack_response.SlackResponse">SlackResponse</a></span>
<span>def <span class="ident">chat_startStream</span></span>(<span>self,<br>*,<br>channel: str,<br>thread_ts: str,<br>markdown_text: str | None = None,<br>recipient_team_id: str | None = None,<br>recipient_user_id: str | None = None,<br>unfurl_links: bool | None = None,<br>unfurl_media: bool | None = None,<br>**kwargs) ‑> <a title="slack_sdk.web.slack_response.SlackResponse" href="slack_response.html#slack_sdk.web.slack_response.SlackResponse">SlackResponse</a></span>
</code></dt>
<dd>
<details class="source">
Expand All @@ -10536,7 +10536,7 @@ <h3>Methods</h3>
self,
*,
channel: str,
thread_ts: Optional[str] = None,
thread_ts: str,
markdown_text: Optional[str] = None,
recipient_team_id: Optional[str] = None,
recipient_user_id: Optional[str] = None,
Expand Down
6 changes: 3 additions & 3 deletions docs/reference/web/legacy_client.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2899,7 +2899,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
self,
*,
channel: str,
thread_ts: Optional[str] = None,
thread_ts: str,
markdown_text: Optional[str] = None,
recipient_team_id: Optional[str] = None,
recipient_user_id: Optional[str] = None,
Expand Down Expand Up @@ -10163,7 +10163,7 @@ <h3>Methods</h3>
<a href="https://api.slack.com/methods/chat.scheduledMessages.list">https://api.slack.com/methods/chat.scheduledMessages.list</a></p></div>
</dd>
<dt id="slack_sdk.web.legacy_client.LegacyWebClient.chat_startStream"><code class="name flex">
<span>def <span class="ident">chat_startStream</span></span>(<span>self,<br>*,<br>channel: str,<br>thread_ts: str | None = None,<br>markdown_text: str | None = None,<br>recipient_team_id: str | None = None,<br>recipient_user_id: str | None = None,<br>unfurl_links: bool | None = None,<br>unfurl_media: bool | None = None,<br>**kwargs) ‑> _asyncio.Future | <a title="slack_sdk.web.legacy_slack_response.LegacySlackResponse" href="legacy_slack_response.html#slack_sdk.web.legacy_slack_response.LegacySlackResponse">LegacySlackResponse</a></span>
<span>def <span class="ident">chat_startStream</span></span>(<span>self,<br>*,<br>channel: str,<br>thread_ts: str,<br>markdown_text: str | None = None,<br>recipient_team_id: str | None = None,<br>recipient_user_id: str | None = None,<br>unfurl_links: bool | None = None,<br>unfurl_media: bool | None = None,<br>**kwargs) ‑> _asyncio.Future | <a title="slack_sdk.web.legacy_slack_response.LegacySlackResponse" href="legacy_slack_response.html#slack_sdk.web.legacy_slack_response.LegacySlackResponse">LegacySlackResponse</a></span>
</code></dt>
<dd>
<details class="source">
Expand All @@ -10174,7 +10174,7 @@ <h3>Methods</h3>
self,
*,
channel: str,
thread_ts: Optional[str] = None,
thread_ts: str,
markdown_text: Optional[str] = None,
recipient_team_id: Optional[str] = None,
recipient_user_id: Optional[str] = None,
Expand Down
2 changes: 1 addition & 1 deletion slack_sdk/web/async_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2878,7 +2878,7 @@ async def chat_startStream(
self,
*,
channel: str,
thread_ts: Optional[str] = None,
thread_ts: str,
markdown_text: Optional[str] = None,
recipient_team_id: Optional[str] = None,
recipient_user_id: Optional[str] = None,
Expand Down
2 changes: 1 addition & 1 deletion slack_sdk/web/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2868,7 +2868,7 @@ def chat_startStream(
self,
*,
channel: str,
thread_ts: Optional[str] = None,
thread_ts: str,
markdown_text: Optional[str] = None,
recipient_team_id: Optional[str] = None,
recipient_user_id: Optional[str] = None,
Expand Down
2 changes: 1 addition & 1 deletion slack_sdk/web/legacy_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2880,7 +2880,7 @@ def chat_startStream(
self,
*,
channel: str,
thread_ts: Optional[str] = None,
thread_ts: str,
markdown_text: Optional[str] = None,
recipient_team_id: Optional[str] = None,
recipient_user_id: Optional[str] = None,
Expand Down
8 changes: 4 additions & 4 deletions tests/slack_sdk_async/web/test_web_client_coverage.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -568,10 +568,10 @@ async def run_method(self, method_name, method, async_method):
self.api_methods_to_call.remove(method()["method"])
await async_method()
elif method_name == "chat_startStream":
self.api_methods_to_call.remove(method(channel="C123")["method"])
method(channel="C123", recipient_team_id="T123", recipient_user_id="U123")
await async_method(channel="C123")
await async_method(channel="C123", recipient_team_id="T123", recipient_user_id="U123")
self.api_methods_to_call.remove(method(channel="C123", thread_ts="123.123")["method"])
await async_method(channel="C123", thread_ts="123.123")
Comment on lines +571 to +572
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧪 praise: Thanks for aligning these tests to expected API calls!

👁️‍🗨️ thought: Once these methods are released we might want to include integration tests for some of these cases since it's not so clear that the recipient information is needed for channels in these arguments. No blocker here since that's so outside the scope of these tests!

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great suggestion @zimeg! I'll add it to our tasks 👌🏻

method(channel="C123", thread_ts="123.123", recipient_team_id="T123", recipient_user_id="U123")
await async_method(channel="C123", thread_ts="123.123", recipient_team_id="T123", recipient_user_id="U123")
Comment on lines +571 to +574
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

newb: There is no need to add a test that asserts that a method requires thread_ts since the tests will fail with a TypeError when a Python function's required argument is missing.

elif method_name == "chat_stopStream":
self.api_methods_to_call.remove(
method(channel="C123", ts="123.123", blocks=[{"type": "markdown", "text": "**twelve**"}])["method"]
Expand Down