[GH-ISSUE #553] feat: Improved documentation for Actions #80

New issue

Closed

opened 2026-10-18 14:08:47 +00:00 by bsakaguchi · 2 comments

bsakaguchi commented

2026-10-18 14:08:47 +00:00

Owner

Originally created by @PlebeiusGaragicus on GitHub (May 19, 2025).
Original GitHub issue: https://github.com/open-webui/docs/issues/553

Originally assigned to: @Classic298 on GitHub.

Check Existing Issues

I have searched the existing issues and discussions.

Problem Description

Given the example Action button code:

class Action:
    class Valves(BaseModel):
        pass

    def __init__(self):
        self.valves = self.Valves()
        pass

    async def action(
        self,
        body: dict,
        __user__=None,
        __event_emitter__=None,
        __event_call__=None,
    ) -> Optional[dict]:
        print(f"action:{__name__}")

        response = await __event_call__(
            {
                "type": "input", # <-- WHAT OTHER OPTIONS EXIST?
                "data": {
                    "title": "write a message",
                    "message": "here write a message to append",
                    "placeholder": "enter your message",
                },
            }
        )

I'd like to know what other options are available other than "type": "input" - I'm unable to find a comprehensive list of options in the docs. Perhaps this is so new they haven't been written yet?

Desired Solution you'd like

Improved documentation.

Alternatives Considered

Creating a comprehensive list of example actions so that I can just review the code.

Additional Context

No response

Originally created by @PlebeiusGaragicus on GitHub (May 19, 2025). Original GitHub issue: https://github.com/open-webui/docs/issues/553 Originally assigned to: @Classic298 on GitHub. ### Check Existing Issues - [x] I have searched the existing issues and discussions. ### Problem Description Given the example Action button code: ```python class Action: class Valves(BaseModel): pass def __init__(self): self.valves = self.Valves() pass async def action( self, body: dict, __user__=None, __event_emitter__=None, __event_call__=None, ) -> Optional[dict]: print(f"action:{__name__}") response = await __event_call__( { "type": "input", # <-- WHAT OTHER OPTIONS EXIST? "data": { "title": "write a message", "message": "here write a message to append", "placeholder": "enter your message", }, } ) ``` I'd like to know what other options are available other than "type": "input" - I'm unable to find a comprehensive list of options in the docs. Perhaps this is so new they haven't been written yet? ### Desired Solution you'd like Improved documentation. ### Alternatives Considered Creating a comprehensive list of example actions so that I can just review the code. ### Additional Context _No response_

bsakaguchi

2026-10-18 14:08:47 +00:00

closed this issue
added the
enhancement

documentation
labels

bsakaguchi commented

2026-10-18 14:08:47 +00:00

Author

Owner

@Classic298 commented on GitHub (Aug 9, 2025):

Additional fields are now documented, please let me know if this is sufficient. Otherwise I can reopen the issue

https://docs.openwebui.com/features/plugin/functions/action

@Classic298 commented on GitHub (Aug 9, 2025): Additional fields are now documented, please let me know if this is sufficient. Otherwise I can reopen the issue https://docs.openwebui.com/features/plugin/functions/action

bsakaguchi commented

2026-10-18 14:08:47 +00:00

Author

Owner

@PlebeiusGaragicus commented on GitHub (Aug 25, 2025):

If you could enumerate every possible option - that'd be great.

Really, I see it's a powerful feature but am unable to see exactly what it can do without reverse-engineering the codebase myself. This is what docs should be for.

@PlebeiusGaragicus commented on GitHub (Aug 25, 2025): If you could enumerate every possible option - that'd be great. Really, I see it's a powerful feature but am unable to see exactly what it can do without reverse-engineering the codebase myself. This is what docs should be for.

bsakaguchi referenced this issue

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

[PR #80] [MERGED] feat: add missing env vars to doc #229