API Docs: Custom steps documentation#1457
Merged
haleychaas merged 3 commits intomainfrom Mar 28, 2025
Merged
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1457 +/- ##
=========================================
Coverage 73.03% 73.03%
- Complexity 4378 4379 +1
=========================================
Files 475 475
Lines 14243 14243
Branches 1447 1447
=========================================
+ Hits 10402 10403 +1
+ Misses 2987 2986 -1
Partials 854 854 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
WilliamBergamin
approved these changes
Mar 28, 2025
Contributor
WilliamBergamin
left a comment
WilliamBergamin
left a comment
There was a problem hiding this comment.
Great work 💯 thanks for working on this
Left a few small comments, once resolved we can merge
docs/content/guides/custom-steps.md
Outdated
| } | ||
| ``` | ||
|
|
||
| Once your custom step is defined in your app's manifest and implemented in code, it is discoverable in Workflow Builder when you **Add Step** and search for the name of your app. No newline at end of file |
Contributor
There was a problem hiding this comment.
Suggested change
| Once your custom step is defined in your app's manifest and implemented in code, it is discoverable in Workflow Builder when you **Add Step** and search for the name of your app. | |
| Once your custom step is defined in your app's manifest and implemented in code, it is discoverable in Workflow Builder when you **Add Step** and search for the title of your step or name of your app. |
docs/content/guides/custom-steps.md
Outdated
| app.function("sample_function", (req, ctx) -> { | ||
| app.executorService().submit(() -> { | ||
| try { | ||
| var userId = req.getEvent().getInputs().get("user_id").asString(); |
Contributor
There was a problem hiding this comment.
Every other code snippet in these docs use the proper type rather then var
Suggested change
| var userId = req.getEvent().getInputs().get("user_id").asString(); | |
| String userId = req.getEvent().getInputs().get("user_id").asString(); |
docs/content/guides/custom-steps.md
Outdated
| app.executorService().submit(() -> { | ||
| try { | ||
| var userId = req.getEvent().getInputs().get("user_id").asString(); | ||
| var response = ctx.client().chatPostMessage(r -> r |
Contributor
There was a problem hiding this comment.
Suggested change
| var response = ctx.client().chatPostMessage(r -> r | |
| ChatPostMessageResponse response = ctx.client().chatPostMessage(r -> r |
docs/content/guides/custom-steps.md
Outdated
| .channel(userId) // sending a DM | ||
| .text("Hi! Thank you for submitting the request! We'll let you know once the processing completes.") | ||
| ); | ||
| var outputs = new HashMap<String, Object>(); |
Contributor
There was a problem hiding this comment.
Suggested change
| var outputs = new HashMap<String, Object>(); | |
| Map<String, Object> outputs = new HashMap<String, Object>(); |
technically-tracy
approved these changes
Mar 28, 2025
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
3 participants
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.
Added a documentation page about custom steps.
Category (place an
xin each of the[ ])Requirements
Please read the Contributing guidelines and Code of Conduct before creating this issue or pull request. By submitting, you agree to those rules.