Skip to content

docs(connector-slack): document the full Slack scope + event set#160

Open
harry-harish wants to merge 1 commit into
mainfrom
docs/connector-slack-scopes
Open

docs(connector-slack): document the full Slack scope + event set#160
harry-harish wants to merge 1 commit into
mainfrom
docs/connector-slack-scopes

Conversation

@harry-harish

@harry-harish harry-harish commented Jul 10, 2026

Copy link
Copy Markdown
Member

What

The @peekdev/connector-slack README's scope table only listed assistant:write + chat:write — it predated the channel/share/journey surfaces. This documents the complete, code-grounded Slack app setup so a maintainer configuring the app doesn't hit silent no-ops.

Grounded against the adapter's actual API calls + event registrations

Also added Event subscriptions + Socket Mode sections and a reinstall note.

Scope

Docs only. @peekdev/connector-slack is private:true (never published) → no changeset. No code change.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated Slack app setup instructions for Socket Mode.
    • Added a detailed overview of required tokens, permissions, and event subscriptions.
    • Documented capabilities including messaging, assistant threads, history access, file uploads, canvases, and mentions.
    • Clarified that permission changes require reinstalling the Slack app.
    • Explained the transition between chat:write and assistant:write permissions.

The scope table only listed assistant:write + chat:write; the shipped
surfaces need more. Grounded each entry against the adapter's actual API
calls / event registrations:
- app_mentions:read (#155 @peek-in-channel), channels/groups/im:history
  (thread auto-continue + DMs), files:write (#156 share_session upload),
  canvases:write (#159 journey canvas), files:read (journey files.info
  permalink — without it the journey degrades to Block Kit), commands (/peek).
- Added Event subscriptions + Socket Mode sections and a reinstall note.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Harish Kumar <22562634+harry-harish@users.noreply.github.com>
@coderabbitai

coderabbitai Bot commented Jul 10, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 19d2db21-d722-49a8-86f8-1678d76020df

📥 Commits

Reviewing files that changed from the base of the PR and between 99d7e1e and 03792a9.

📒 Files selected for processing (1)
  • packages/connector-slack/README.md

📝 Walkthrough

Walkthrough

The Slack connector README now documents Socket Mode setup, capability-specific bot scopes, required bot events, app reinstall requirements after scope changes, and the interaction between chat:write and assistant:write.

Changes

Slack connector setup

Layer / File(s) Summary
Slack scopes and event setup
packages/connector-slack/README.md
Documents Socket Mode tokens, maps bot scopes to connector capabilities, lists required bot events, explains app reinstall requirements, and clarifies chat:write and assistant:write behavior.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

Poem

I’m a rabbit with Slack scopes to share,
Events and tokens neatly laid bare.
Reinstall when permissions take flight,
Keep both write scopes for thinking done right.
Hop, hop—the setup is clear tonight!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the documentation update covering Slack scopes and event subscriptions.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant