[PR #1265] [MERGED] fix: add metadata fields and __event_emitter__ custom types #1253

New issue

Closed

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

bsakaguchi commented

2026-10-18 14:18:20 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/open-webui/docs/pull/1265
Author: @Turrabo
Created: 5/25/2026
Status: ✅ Merged
Merged: 5/25/2026
Merged by: @Classic298

Base: main ← Head: fix/document-metadata-and-event-emitter-fields

📝 Commits (1)

fca2145 fix: add metadata fields and event_emitter custom types

📊 Changes

1 file changed (+51 additions, -1 deletions)

View changed files

📝 docs/features/extensibility/plugin/development/reserved-args.mdx (+51 -1)

📄 Description

Summary

add user_prompt, system_prompt, sources to the __metadata__ JSON example
add a tip under __metadata__ explaining capture intent and recommended Pipe usage
expand __event_emitter__ to cover custom type forwarding through socket.io

Why

The current __metadata__ example is missing three fields that the backend populates. The __event_emitter__ section doesn't mention that custom type strings are forwarded to socket.io clients. Both of these things actually exist in OWUI today but aren't documented (and would've saved me a day of hacking).

_{🔄 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/1265 **Author:** [@Turrabo](https://github.com/Turrabo) **Created:** 5/25/2026 **Status:** ✅ Merged **Merged:** 5/25/2026 **Merged by:** [@Classic298](https://github.com/Classic298) **Base:** `main` ← **Head:** `fix/document-metadata-and-event-emitter-fields` --- ### 📝 Commits (1) - [`fca2145`](https://github.com/open-webui/docs/commit/fca21455a1790d165d4aac60ef6ecd5c90cd17d0) fix: add __metadata__ fields and __event_emitter__ custom types ### 📊 Changes **1 file changed** (+51 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `docs/features/extensibility/plugin/development/reserved-args.mdx` (+51 -1) </details> ### 📄 Description ## Summary - add `user_prompt`, `system_prompt`, `sources` to the `__metadata__` JSON example - add a tip under `__metadata__` explaining capture intent and recommended Pipe usage - expand `__event_emitter__` to cover custom `type` forwarding through socket.io ## Why The current `__metadata__` example is missing three fields that the backend populates. The `__event_emitter__` section doesn't mention that custom `type` strings are forwarded to socket.io clients. Both of these things actually exist in OWUI today but aren't documented (and would've saved me a day of hacking). --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-18 14:18:20 +00:00