fix: webhook node output file as file variable
[!IMPORTANT]
- Make sure you have read our contribution guidelines
- Ensure there is an associated issue and you have been assigned to it
- Use the correct syntax to link this PR:
Fixes #<issue number>.
Summary
fix #29585 webhook node output file as file variable
Screenshots
| Before | After |
|---|---|
| ... | ... |
curl -X POST \
-F 'file=@./ScreenShot_2025-12-11_203810_501.png;type=image/png' \
'http://localhost:5001/triggers/webhook-debug/HMdzESKmTLvjL2bPnh_zu93V'
Checklist
- [ ] This change requires a documentation update, included: Dify Document
- [x] I understand that this PR may be closed in case there was no previous discussion or issues. (This doesn't apply to typos!)
- [x] I've added a test for each change that was introduced, and I tried as much as possible to make a single atomic change.
- [x] I've updated the documentation accordingly.
- [x] I ran
dev/reformat(backend) andcd web && npx lint-staged(frontend) to appease the lint gods
Summary of Changes
Hello @fatelei, I'm Gemini Code Assist[^1]! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request addresses a critical issue where the webhook node in workflows was not correctly processing and outputting file variables. The primary goal is to ensure that any file uploads received via a webhook are properly transformed into FileVariable objects. This standardization is essential for seamless integration with other workflow nodes that expect specific file types, thereby enhancing the overall stability and functionality of file handling within the Dify platform.
Highlights
-
Webhook Node File Output: Files received by webhook nodes are now correctly converted into
FileVariableobjects, ensuring proper typing for downstream workflow nodes. -
Improved Compatibility: This change resolves issues where subsequent nodes in a workflow (e.g., LLM nodes) might have failed due to expecting
FileVariabletypes but receiving raw file dictionaries from webhooks. -
Robust File Handling: The file conversion process now includes error handling, allowing the system to fall back to the original file data if the
FileVariableconversion encounters an issue. - Comprehensive Testing: New dedicated unit tests have been added, and existing unit and integration tests have been updated to thoroughly validate the new file conversion logic across various scenarios.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in pull request comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with :thumbsup: and :thumbsdown: on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
[^1]: Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.
I try to execute
curl -X POST -F 'aa=@/tmp/a.txt' -F 'foo=bar' http://localhost:5001/triggers/webhook-debug/e0iYYehFyoZ_h9qQltKjaPlO
will raise exeception:
2025-12-15 09:20:21,199 INFO [_internal.py:97] 127.0.0.1 - - [15/Dec/2025 09:20:21] "GET /console/api/workspaces/current/triggers HTTP/1.1" 200 -
2025-12-15 09:20:21,186 ERROR [node.py:329] 3949f305ba Node 1765698182076 failed to run
Traceback (most recent call last):
File "/Users/hejl/projects/dify/api/core/workflow/nodes/base/node.py", line 311, in run
result = self._run()
^^^^^^^^^^^
File "/Users/hejl/projects/dify/api/core/workflow/nodes/trigger_webhook/node.py", line 58, in _run
outputs = self._extract_configured_outputs(webhook_inputs)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/Users/hejl/projects/dify/api/core/workflow/nodes/trigger_webhook/node.py", line 125, in _extract_configured_outputs
file = files["file"]
~~~~~^^^^^^^^
KeyError: 'file'
2025-12-15 09:20:21,230 ERROR [error_handler.py:101] Node 1765698182076 failed with ABORT strategy: 'file'
I try to execute
curl -X POST -F 'aa=@/tmp/a.txt' -F 'foo=bar' http://localhost:5001/triggers/webhook-debug/e0iYYehFyoZ_h9qQltKjaPlOwill raise exeception:2025-12-15 09:20:21,199 INFO [_internal.py:97] 127.0.0.1 - - [15/Dec/2025 09:20:21] "GET /console/api/workspaces/current/triggers HTTP/1.1" 200 - 2025-12-15 09:20:21,186 ERROR [node.py:329] 3949f305ba Node 1765698182076 failed to run Traceback (most recent call last): File "/Users/hejl/projects/dify/api/core/workflow/nodes/base/node.py", line 311, in run result = self._run() ^^^^^^^^^^^ File "/Users/hejl/projects/dify/api/core/workflow/nodes/trigger_webhook/node.py", line 58, in _run outputs = self._extract_configured_outputs(webhook_inputs) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/Users/hejl/projects/dify/api/core/workflow/nodes/trigger_webhook/node.py", line 125, in _extract_configured_outputs file = files["file"] ~~~~~^^^^^^^^ KeyError: 'file' 2025-12-15 09:20:21,230 ERROR [error_handler.py:101] Node 1765698182076 failed with ABORT strategy: 'file'
how about your dsl