Note to first-time contributors: Please open a discussion post in Discussions to discuss your idea/fix with the community before creating a pull request, and describe your changes before submitting a pull request.
This is to ensure large feature PRs are discussed with the community first, before starting work on it. If the community does not want this feature or it is not relevant for Open WebUI as a project, it can be identified in the discussion before working on the feature and submitting the PR.
Before submitting, make sure you've checked the following:
Target branch: Verify that the pull request targets the dev branch. Not targeting the dev branch will lead to immediate closure of the PR.
Description: Provide a concise description of the changes made in this pull request down below.
Changelog: Ensure a changelog entry following the format of Keep a Changelog is added at the bottom of the PR description.
Documentation: If necessary, update relevant documentation Open WebUI Docs like environment variables, the tutorials, or other documentation sources.
Dependencies: Are there any new dependencies? Have you updated the dependency versions in the documentation?
Testing: Perform manual tests to verify the implemented fix/feature works as intended AND does not break any other functionality. Take this as an opportunity to make screenshots of the feature/fix and include it in the PR description.
Agentic AI Code: Confirm this Pull Request is not written by any AI Agent or has at least gone through additional human review AND manual testing. If any AI Agent is the co-author of this PR, it may lead to immediate closure of the PR.
Code review: Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards?
Title Prefix: To clearly categorize this pull request, prefix the pull request title using one of the following:
BREAKING CHANGE: Significant changes that may affect compatibility
build: Changes that affect the build system or external dependencies
ci: Changes to our continuous integration processes or workflows
chore: Refactor, cleanup, or other non-functional code changes
docs: Documentation update or addition
feat: Introduces a new feature or enhancement to the codebase
fix: Bug fix or error correction
i18n: Internationalization or localization changes
perf: Performance improvement
refactor: Code restructuring for better maintainability, readability, or scalability
style: Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc.)
test: Adding missing tests or correcting existing tests
WIP: Work in progress, a temporary label for incomplete or ongoing work
Changelog Entry
Description
This PR adds a new event type chat:message:favorite that allows Action Functions to update the favorite (pin) status of a message in the frontend cache. Without this event, Action Functions that modify message.favorite in the database have their changes immediately overwritten when the frontend auto-saves its cached state.
This enables the development of "Pin Message" action functions that integrate with the existing heart/favorite functionality in the Chat Overview.
Added
New chat:message:favorite event handler in Chat.svelte that updates message.favorite from event data
Additional Information
This is a minimal 2-line addition that follows the existing pattern for message property event handlers (similar to chat:message:files, chat:message:embeds, chat:message:error, etc.)
Enables Action Functions to properly toggle the pin/favorite status without race conditions with the frontend's auto-save behavior
The change adds extensibility for plugin developers without affecting existing functionality
Usage from Action Functions:
await__event_emitter__({"type":"chat:message:favorite","data":{"favorite":True}# or False to unpin})
This change specifically helps power the Pin Message Action I've published recently on the community platform website. It enables Action Functions to toggle the message.favorite property (displayed as a heart in the Chat Overview), allowing users to quickly pin/unpin important messages directly from the message toolbar. Without this event, the frontend's auto-save behavior overwrites any database changes made by Action Functions.
Contributor License Agreement
By submitting this pull request, I confirm that I have read and fully agree to the Contributor License Agreement (CLA), and I am providing my contributions under its terms.
Note
Deleting the CLA section will lead to immediate closure of your PR and it will not be merged in.
🔄 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/open-webui/pull/20375
**Author:** [@silentoplayz](https://github.com/silentoplayz)
**Created:** 1/5/2026
**Status:** ✅ Merged
**Merged:** 1/5/2026
**Merged by:** [@tjbck](https://github.com/tjbck)
**Base:** `dev` ← **Head:** `feat/message-favorite-event`
---
### 📝 Commits (4)
- [`ebdae49`](https://github.com/open-webui/open-webui/commit/ebdae490ef9e51a2d6ae4638625662f487475641) feat: add chat:message:favorite event for action functions
- [`abfb0f6`](https://github.com/open-webui/open-webui/commit/abfb0f6a5613b5b9c36105cdd68797e384cb774a) Update Chat.svelte
- [`605ff05`](https://github.com/open-webui/open-webui/commit/605ff05afd45030db064c22cf0c0d38f078b7603) Update Chat.svelte
- [`969300f`](https://github.com/open-webui/open-webui/commit/969300fd6155f521ac489a94d7eb649be2fc69d0) Merge branch 'feat/message-favorite-event' of https://github.com/silentoplayz/open-webui into feat/message-favorite-event
### 📊 Changes
**1 file changed** (+3 additions, -0 deletions)
<details>
<summary>View changed files</summary>
📝 `src/lib/components/chat/Chat.svelte` (+3 -0)
</details>
### 📄 Description
# Pull Request Checklist
### Note to first-time contributors: Please open a discussion post in [Discussions](https://github.com/open-webui/open-webui/discussions) to discuss your idea/fix with the community before creating a pull request, and describe your changes before submitting a pull request.
This is to ensure large feature PRs are discussed with the community first, before starting work on it. If the community does not want this feature or it is not relevant for Open WebUI as a project, it can be identified in the discussion before working on the feature and submitting the PR.
**Before submitting, make sure you've checked the following:**
- [x] **Target branch:** Verify that the pull request targets the `dev` branch. **Not targeting the `dev` branch will lead to immediate closure of the PR.**
- [x] **Description:** Provide a concise description of the changes made in this pull request down below.
- [x] **Changelog:** Ensure a changelog entry following the format of [Keep a Changelog](https://keepachangelog.com/) is added at the bottom of the PR description.
- [X] **Documentation:** If necessary, update relevant documentation [Open WebUI Docs](https://github.com/open-webui/docs) like environment variables, the tutorials, or other documentation sources.
- [x] **Dependencies:** Are there any new dependencies? Have you updated the dependency versions in the documentation?
- [x] **Testing:** Perform manual tests to **verify the implemented fix/feature works as intended AND does not break any other functionality**. Take this as an opportunity to **make screenshots of the feature/fix and include it in the PR description**.
- [x] **Agentic AI Code:** Confirm this Pull Request is **not written by any AI Agent** or has at least **gone through additional human review AND manual testing**. If any AI Agent is the co-author of this PR, it may lead to immediate closure of the PR.
- [x] **Code review:** Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards?
- [x] **Title Prefix:** To clearly categorize this pull request, prefix the pull request title using one of the following:
- **BREAKING CHANGE**: Significant changes that may affect compatibility
- **build**: Changes that affect the build system or external dependencies
- **ci**: Changes to our continuous integration processes or workflows
- **chore**: Refactor, cleanup, or other non-functional code changes
- **docs**: Documentation update or addition
- **feat**: Introduces a new feature or enhancement to the codebase
- **fix**: Bug fix or error correction
- **i18n**: Internationalization or localization changes
- **perf**: Performance improvement
- **refactor**: Code restructuring for better maintainability, readability, or scalability
- **style**: Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc.)
- **test**: Adding missing tests or correcting existing tests
- **WIP**: Work in progress, a temporary label for incomplete or ongoing work
# Changelog Entry
### Description
This PR adds a new event type `chat:message:favorite` that allows Action Functions to update the `favorite` (pin) status of a message in the frontend cache. Without this event, Action Functions that modify `message.favorite` in the database have their changes immediately overwritten when the frontend auto-saves its cached state.
This enables the development of "Pin Message" action functions that integrate with the existing heart/favorite functionality in the Chat Overview.
### Added
- New `chat:message:favorite` event handler in [Chat.svelte](cci:7://file:///home/g30/docker-projects/open-webui-dev/src/lib/components/chat/Chat.svelte:0:0-0:0) that updates `message.favorite` from event data
---
### Additional Information
- This is a minimal 2-line addition that follows the existing pattern for message property event handlers (similar to `chat:message:files`, `chat:message:embeds`, `chat:message:error`, etc.)
- Enables Action Functions to properly toggle the pin/favorite status without race conditions with the frontend's auto-save behavior
- The change adds extensibility for plugin developers without affecting existing functionality
**Usage from Action Functions:**
```python
await __event_emitter__({
"type": "chat:message:favorite",
"data": {"favorite": True} # or False to unpin
})
```
- Semi-related merged PR - https://github.com/open-webui/open-webui/pull/20337
### Motivation
- This change specifically helps power the [Pin Message Action](hhttps://openwebui.com/posts/143594d1-0838-4f9a-9af2-b94d2952f7ba) I've published recently on the community platform website. It enables Action Functions to toggle the `message.favorite` property (displayed as a heart in the Chat Overview), allowing users to quickly pin/unpin important messages directly from the message toolbar. Without this event, the frontend's auto-save behavior overwrites any database changes made by Action Functions.
### Contributor License Agreement
By submitting this pull request, I confirm that I have read and fully agree to the [Contributor License Agreement (CLA)](https://github.com/open-webui/open-webui/blob/main/CONTRIBUTOR_LICENSE_AGREEMENT), and I am providing my contributions under its terms.
> [!NOTE]
> Deleting the CLA section will lead to immediate closure of your PR and it will not be merged in.
---
<sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
📋 Pull Request Information
Original PR: https://github.com/open-webui/open-webui/pull/20375
Author: @silentoplayz
Created: 1/5/2026
Status: ✅ Merged
Merged: 1/5/2026
Merged by: @tjbck
Base:
dev← Head:feat/message-favorite-event📝 Commits (4)
ebdae49feat: add chat:message:favorite event for action functionsabfb0f6Update Chat.svelte605ff05Update Chat.svelte969300fMerge branch 'feat/message-favorite-event' of https://github.com/silentoplayz/open-webui into feat/message-favorite-event📊 Changes
1 file changed (+3 additions, -0 deletions)
View changed files
📝
src/lib/components/chat/Chat.svelte(+3 -0)📄 Description
Pull Request Checklist
Note to first-time contributors: Please open a discussion post in Discussions to discuss your idea/fix with the community before creating a pull request, and describe your changes before submitting a pull request.
This is to ensure large feature PRs are discussed with the community first, before starting work on it. If the community does not want this feature or it is not relevant for Open WebUI as a project, it can be identified in the discussion before working on the feature and submitting the PR.
Before submitting, make sure you've checked the following:
devbranch. Not targeting thedevbranch will lead to immediate closure of the PR.Changelog Entry
Description
This PR adds a new event type
chat:message:favoritethat allows Action Functions to update thefavorite(pin) status of a message in the frontend cache. Without this event, Action Functions that modifymessage.favoritein the database have their changes immediately overwritten when the frontend auto-saves its cached state.This enables the development of "Pin Message" action functions that integrate with the existing heart/favorite functionality in the Chat Overview.
Added
chat:message:favoriteevent handler in Chat.svelte that updatesmessage.favoritefrom event dataAdditional Information
chat:message:files,chat:message:embeds,chat:message:error, etc.)Usage from Action Functions:
Motivation
message.favoriteproperty (displayed as a heart in the Chat Overview), allowing users to quickly pin/unpin important messages directly from the message toolbar. Without this event, the frontend's auto-save behavior overwrites any database changes made by Action Functions.Contributor License Agreement
By submitting this pull request, I confirm that I have read and fully agree to the Contributor License Agreement (CLA), and I am providing my contributions under its terms.
🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.