Skip to content

docs: document workflow token behaviors #2500

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.

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

Open
WilliamBergamin opened this issue Apr 14, 2025 · 2 comments
Open

docs: document workflow token behaviors #2500

WilliamBergamin opened this issue Apr 14, 2025 · 2 comments
Labels
auto-triage-skip Prevent this issue from being closed due to lack of activity docs M-T: Documentation work only enhancement M-T: A feature request for new functionality

Comments

@WilliamBergamin
Copy link
Contributor

Assumptions that bolt makes around workflow token and how they are used is not documented, this can lead to some confusion. I think we should document that whenever a workflow token is found in an event payload it will be used by the client injected into the handler. It is also worth documenting that this behavior can be disabled with attachFunctionToken = false

List any relevant URLs

https://tools.slack.dev/bolt-js/concepts/custom-steps

Requirements

Please read the Contributing guidelines and Code of Conduct before creating this issue or pull request. By submitting, you are agreeing to those rules.

@WilliamBergamin WilliamBergamin added docs M-T: Documentation work only enhancement M-T: A feature request for new functionality labels Apr 14, 2025
@zimeg
Copy link
Member

zimeg commented Apr 29, 2025

📝 While this is still fresh in mind, we might want to also include notes of how this token is available in context:

https://tools.slack.dev/bolt-js/concepts/context

A potential change of #2513 might also be applied to this, but that's not so certain at the moment 🫡

Copy link

github-actions bot commented Jun 2, 2025

👋 It looks like this issue has been open for 30 days with no activity. We'll mark this as stale for now, and wait 10 days for an update or for further comment before closing this issue out. If you think this issue needs to be prioritized, please comment to get the thread going again! Maintainers also review issues marked as stale on a regular basis and comment or adjust status if the issue needs to be reprioritized.

@zimeg zimeg added auto-triage-skip Prevent this issue from being closed due to lack of activity and removed auto-triage-stale labels Jun 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-triage-skip Prevent this issue from being closed due to lack of activity docs M-T: Documentation work only enhancement M-T: A feature request for new functionality
Projects
None yet
Development

No branches or pull requests

2 participants