mirror of
https://github.com/open-webui/docs.git
synced 2026-07-20 15:38:19 -04:00
Documentation for event emitter endpoint in order to send tool events from external tools #150
Reference in New Issue
Block a user
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Originally created by @reuschling on GitHub (Feb 6, 2026).
I asked for clarification inside the documentation whether tool events are supported in python implemented tools only. Nicely the documentation now clearly says that events are not supported with OpenAPI and MCP based tools, at least in the sense of "just use the event emitter".
Then I created a feature request for supporting tool events with external tools also. @tjbck said that there exists an endpoint to emit events to a specific message yet. This means, if an external tool becomes the information to the caller identifier, e.g. with an http header entry, it is possible for external tools to deal with tool requests.
This is currently undocumented as far as I know, @Classic298 says it would be time for another doc issue regarding this. Here it is, thanks a lot.
@Classic298 commented on GitHub (Feb 6, 2026):
thanks i'm gonna take a look
@Classic298 commented on GitHub (Feb 6, 2026):
found it
@Classic298 commented on GitHub (Feb 6, 2026):
see here
https://github.com/open-webui/docs/pull/1051/changes/a9720eb2e8c71ca50cd4f7b97345a64c246a76cb
added to dev
@reuschling commented on GitHub (Feb 6, 2026):
Again, thank you very much. This helps a lot.
@FloMrt commented on GitHub (Feb 10, 2026):
Hi @Classic298 !
Thanks for the updated doc
But no way for me to make it work :( (either with MCP or OpenAPI external tool server).
My OWUI instance is launched with ENABLE_FORWARD_USER_INFO_HEADERS=True but no chat / message id is present in the header on the tool server side...
@Classic298 commented on GitHub (Feb 10, 2026):
@FloMrt
only in the next version: chat id will be sent to external tools with enable forward user info header
message id still not sent even with next version - unless this PR is merged https://github.com/open-webui/open-webui/pull/21214
for full compatibility we need this PR to be merged.
Feel free to vouch for the PR in the comments.
If this PR is merged then in the next version chat id and message id are both sent to external tool and you can call event emitter
@Classic298 commented on GitHub (Feb 10, 2026):
@reuschling
@Classic298 commented on GitHub (Feb 10, 2026):
and PS:
@FloMrt this is why i commited the docs changes to dev branch. Because they are not possible yet with current main version.
The docs as they are now are still correct: external event emitter usage is de-facto impossible because you dont get the chat id and message id
@FloMrt commented on GitHub (Feb 10, 2026):
Much clearer thanks !
@Classic298 commented on GitHub (Feb 12, 2026):
pr merged nice
@FloMrt commented on GitHub (Feb 13, 2026):
Thanks @Classic298 for the PR !
@reuschling commented on GitHub (Feb 13, 2026):
Yes, thank you @Classic298 for your effort!