docs(slack): add scopes per operation, use case examples, and compatibility - #3307
Open
endikafercu wants to merge 3 commits into
Open
docs(slack): add scopes per operation, use case examples, and compatibility#3307endikafercu wants to merge 3 commits into
endikafercu wants to merge 3 commits into
Conversation
## Summary - Add comprehensive documentation for the Slack connector (6 operations: Send Message, Send DM, Update Message, Upload File, Create Channel, Invite to Channel) - Covers Slack App setup, required OAuth scopes, all input/output parameters per operation, retry behavior, and troubleshooting - Add navigation entry and connector index card ## Files changed - `modules/process/pages/slack-connector.adoc` — new documentation page - `modules/process/process-nav.adoc` — nav entry under Bonita official connectors - `modules/process/pages/connectors-index.adoc` — index card ## Test plan - [ ] Verify Antora build succeeds - [ ] Verify all xref links resolve correctly - [ ] Review parameter tables match connector .def files - [ ] Check preview rendering 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
Co-authored-by: tbouffard <27200110+tbouffard@users.noreply.github.com>
Updates based on end-to-end testing of all 6 operations in Bonita Studio 2026.1 and Bonita 10.4.0 Docker: - Add availability line (required by skill3) - Title: "Slack connectors" (plural, per skill3 convention) - Rewrite scopes section: table per OPERATION (not per scope), including Slack API methods used. Much clearer for configuration. - Add tips: recommend recipientEmail over recipientUserId for DMs - Add 3 use case examples: project channel workflow, status update with file upload, direct notification by email - Add troubleshooting: channel_not_found, Studio "not found" deps - Add compatibility matrix (Bonita 10.2+, Java 17+, SDK 1.48.0) - Add source code link to GitHub Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Contributor
📝 Contribution SummaryTo merge this Pull Request, you need to check your updates with the following URL. 🔗 Updated pagesNote The following pages were updated, please ensure that the display is correct: |
Contributor
|
🎊 PR Preview 4cb779a has been successfully built and deployed to https://bonitasoft-bonita-doc-deploy-pr-3307.surge.sh 🕐 Build time: 0.011s
🤖 By surge-preview |
|
|
Contributor
|
This PR is stale because it has been open 14 days with no activity. Remove stale label or comment or this will be closed in 10 days. |
github-actions
Bot
added
the
Stale - no activity
tbouffard
added
no-stale
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Updates the Slack connector documentation page with improvements discovered during real end-to-end testing of all 6 operations in Bonita Studio.
Builds on top of #3280 (cherry-pick/slack-docs-to-2024.3).
Changes
Scopes per operation (key improvement)
Replaced the scope-centric table with an operation-centric table that shows exactly which scopes each operation needs, plus the Slack API methods used. This was the #1 pain point during testing -- users need to know "I want to send a DM, what scopes do I add?"
Use case examples (new)
Three real-world patterns:
Other additions
recipientEmailoverrecipientUserIdchannel_not_found, Studio dependency "not found"Related
cc @pabloalonso