docs: Add HTTP request workflow node documentation and examples #2789
Conversation
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
…schema - Add database migration for HTTP request block columns - Update workflow models to support HTTP request blocks - Add HTTP request block parsing and validation - Update workflow service to handle HTTP request execution - Add database model changes for HTTP request parameters
- Add comprehensive documentation for HTTP request workflow blocks - Include example YAML workflow configuration - Add usage examples and implementation guides - Provide reference documentation for developers
Contributor
There was a problem hiding this comment.
Important
Looks good to me! 👍
Reviewed everything up to 64098c2 in 39 seconds. Click for details.
- Reviewed
269lines of code in2files - Skipped
0files when reviewing. - Skipped posting
2draft comments. View those below. - Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.
1. docs/http_request_block.md:179
- Draft comment:
Consider adding a newline at the end of the file for consistency and POSIX compliance. - Reason this comment was not posted:
Confidence changes required:33%<= threshold50%None
2. examples/http_request_workflow.yaml:74
- Draft comment:
Ensure that the 'current_timestamp' variable used in the 'webhook_notification' block is defined or documented, so users know its origin. - Reason this comment was not posted:
Confidence changes required:33%<= threshold50%None
Workflow ID: wflow_TQ0D5MNWGsZlIqjW
You can customize by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.
Contributor
There was a problem hiding this comment.
Important
Looks good to me! 👍
Reviewed f2d3ac7 in 1 minute and 7 seconds. Click for details.
- Reviewed
466lines of code in5files - Skipped
0files when reviewing. - Skipped posting
5draft comments. View those below. - Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.
1. skyvern/forge/sdk/workflow/service.py:1127
- Draft comment:
Using 'asyncio.timeout' requires Python 3.11 or newer. If older versions must be supported, consider a fallback solution or document this dependency. - Reason this comment was not posted:
Comment was not on a location in the diff, so it can't be submitted as a review comment.
2. skyvern/forge/sdk/workflow/service.py:1328
- Draft comment:
The webhook payload is being logged (payload=payload); this could expose sensitive data. Consider redacting or masking sensitive fields in the log. - Reason this comment was not posted:
Comment was not on a location in the diff, so it can't be submitted as a review comment.
3. skyvern/forge/sdk/workflow/service.py:1427
- Draft comment:
The function 'persist_debug_artifacts' (and related artifact persistence calls) executes tasks sequentially. Consider using 'asyncio.gather' to run independent persistence tasks concurrently for potential performance improvements. - Reason this comment was not posted:
Comment was not on a location in the diff, so it can't be submitted as a review comment.
4. skyvern/forge/sdk/workflow/models/yaml.py:20
- Draft comment:
Several Literal fields use 'type: ignore' due to mypy issues. Consider documenting the specific mypy bug reference and reviewing if an update to mypy might eliminate these ignores in the future. - Reason this comment was not posted:
Comment was not on a location in the diff, so it can't be submitted as a review comment.
5. skyvern/forge/sdk/workflow/service.py:325
- Draft comment:
The 'execute_workflow' function is quite long and handles many responsibilities. Refactoring it into smaller helper functions could improve readability and maintainability. - Reason this comment was not posted:
Comment was not on a location in the diff, so it can't be submitted as a review comment.
Workflow ID: wflow_DiKPtfNjxxIgGwVQ
You can customize by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.
suchintan
reviewed
Jun 25, 2025
| @@ -0,0 +1,180 @@ | |||
| # HTTP Request Block | |||
Contributor
There was a problem hiding this comment.
Docs go into fern/ not here.
Contributor
There was a problem hiding this comment.
All docs should either show up in docs.skyvern.com or nowhere
suchintan
reviewed
Jun 25, 2025
| op.add_column( | ||
| "tasks", sa.Column("credentials", postgresql.JSON(astext_type=sa.Text()), autoincrement=False, nullable=True) | ||
| ) | ||
| op.add_column( |
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.
Important
Add documentation and examples for HTTP request workflow blocks, update database schema, and enhance
HttpRequestBlockfunctionality.docs/http_request_block.mdwith comprehensive documentation for HTTP request workflow blocks, including features, configuration, parameters, output format, usage examples, template variables, error handling, integration, and best practices.examples/http_request_workflow.yamlwith example YAML workflow configurations demonstrating HTTP request block usage.2025_06_25_0043-7099cf601169_add_http_request_block_columns_to_.pyto add columnscurl_command,method,url,headers,timeout, andfollow_redirectstoworkflow_run_blockstable.HttpRequestBlockinblock.pyto support new parameters and parsing ofcurl_command.HttpRequestBlockYAMLinyaml.pyto define YAML structure for HTTP request blocks.HttpRequestBlockinservice.pyfor workflow execution.This description was created by
for f2d3ac7. You can customize this summary. It will automatically update as commits are pushed.