[PR #1404] [MERGED] docs: correct the event function and events pages against events.py and the chat client #1369

New issue

Closed

opened 2026-10-18 14:19:12 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-18 14:19:12 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/open-webui/docs/pull/1404
Author: @silentoplayz
Created: 9/18/2026
Status: ✅ Merged
Merged: 9/18/2026
Merged by: @Classic298

Base: main ← Head: docs/event-pages

📝 Commits (1)

3314650 docs: correct the event function and events pages against events.py and the chat client

📊 Changes

2 files changed (+21 additions, -17 deletions)

View changed files

📝 docs/features/extensibility/plugin/development/events.mdx (+20 -16)
📝 docs/features/extensibility/plugin/functions/event.mdx (+1 -1)

📄 Description

Summary

I compared the Event Function page and the Events page with events.py, socket/main.py and Chat.svelte on dev.

The notification catalog has five events, not four: retrieval.content.process_failed was missing.
chat:title takes the title string itself as data. The page showed {"title": ...}, which would set the title store to an object. The backend emits the bare string after title generation.
chat:tags does not carry tags. The browser ignores data and reloads the chat's tags from the server, so a plugin has to write the tags first and emit the event as a refresh signal. The table, the section and the FAQ now say so, with a working example.
Added: notifications are dropped for internal requests, execute never replies when the JavaScript throws so the call waits for the timeout, input supports a select via input.type and options and returns false on cancel, and nothing is persisted for temporary or channel chats.

None.

Checklist

I have reviewed the relevant documentation and matched the existing style.
This PR meets Open WebUI's contribution standards: it is accurate, relevant to users, narrowly scoped, maintainable, and not promotional content, advertising, lead generation, SEO placement, or a request to list a product, service, provider, integration, gateway, tool, or company primarily for visibility.
I understand that PRs that do not meet these standards may be closed without review and will not be merged. Repeated, low-quality, off-topic, promotional, or intentionally misleading submissions may result in the contributor being blocked from future participation in Open WebUI repositories.

Notes for reviewers

Sources on dev: NOTIFICATION_EVENTS in events.py, the chat:title and chat:tags handlers in Chat.svelte, the emit sites in utils/middleware.py, the internal-notification and is_saved_chat_id checks in socket/main.py, and the execute and input handlers in Chat.svelte.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/open-webui/docs/pull/1404 **Author:** [@silentoplayz](https://github.com/silentoplayz) **Created:** 9/18/2026 **Status:** ✅ Merged **Merged:** 9/18/2026 **Merged by:** [@Classic298](https://github.com/Classic298) **Base:** `main` ← **Head:** `docs/event-pages` --- ### 📝 Commits (1) - [`3314650`](https://github.com/open-webui/docs/commit/33146505bdf15757d3418afca419cb66a4d8d2fa) docs: correct the event function and events pages against events.py and the chat client ### 📊 Changes **2 files changed** (+21 additions, -17 deletions) <details> <summary>View changed files</summary> 📝 `docs/features/extensibility/plugin/development/events.mdx` (+20 -16) 📝 `docs/features/extensibility/plugin/functions/event.mdx` (+1 -1) </details> ### 📄 Description ## Summary I compared the Event Function page and the Events page with `events.py`, `socket/main.py` and `Chat.svelte` on `dev`. - The notification catalog has five events, not four: `retrieval.content.process_failed` was missing. - `chat:title` takes the title string itself as `data`. The page showed `{"title": ...}`, which would set the title store to an object. The backend emits the bare string after title generation. - `chat:tags` does not carry tags. The browser ignores `data` and reloads the chat's tags from the server, so a plugin has to write the tags first and emit the event as a refresh signal. The table, the section and the FAQ now say so, with a working example. - Added: notifications are dropped for internal requests, `execute` never replies when the JavaScript throws so the call waits for the timeout, `input` supports a select via `input.type` and `options` and returns `false` on cancel, and nothing is persisted for temporary or channel chats. ## Related issue or discussion None. ## Checklist - [x] I have reviewed the relevant documentation and matched the existing style. - [x] This PR meets Open WebUI's contribution standards: it is accurate, relevant to users, narrowly scoped, maintainable, and not promotional content, advertising, lead generation, SEO placement, or a request to list a product, service, provider, integration, gateway, tool, or company primarily for visibility. - [x] I understand that PRs that do not meet these standards may be closed without review and will not be merged. Repeated, low-quality, off-topic, promotional, or intentionally misleading submissions may result in the contributor being blocked from future participation in Open WebUI repositories. ## Notes for reviewers Sources on `dev`: `NOTIFICATION_EVENTS` in `events.py`, the `chat:title` and `chat:tags` handlers in `Chat.svelte`, the emit sites in `utils/middleware.py`, the internal-notification and `is_saved_chat_id` checks in `socket/main.py`, and the `execute` and `input` handlers in `Chat.svelte`. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-18 14:19:12 +00:00