> ## Documentation Index > Fetch the complete documentation index at: https://developer.watson-orchestrate.ibm.com/llms.txt > Use this file to discover all available pages before exploring further. # Release notes for embedded chat This page documents new features, enhancements, and updates for the embedded chat integration. Changes are listed in chronological order by release date. For information about new features and improvements to the watsonx Orchestrate product, see [What's new in IBM® watsonx Orchestrate®](https://www.ibm.com/docs/en/watsonx/watson-orchestrate/base?topic=notes-whats-new). ## New feature ### Custom HTML content with writeable elements Added the [`getWriteableElement()`](methods/getWriteableElement) method to inject custom HTML content into specific locations within the chat interface. This method provides six strategic injection points for adding notifications, banners, carousels, images, and other interactive content to enhance the chat experience. For more information, see the documentation for [`getWriteableElement()`](methods/getWriteableElement) method. ## Documentation improvements ### UI configuration reference documentation Restructured the [UI Configuration](ui_configuration) documentation from table-based format to individual parameter entries with dedicated code examples. Each configuration parameter now includes: * **Structured parameter fields**: Clear presentation of parameter path, type, and default values using ParamField components. * **Individual code examples**: Focused, syntax-highlighted examples showing exactly where each parameter is used in the configuration. This update improves the developer experience by making it easier to find specific configuration options and understand how to implement them. ## Enhancements ### Font customization Added the `fontFamily` parameter to the `style` configuration object as an optional string parameter. This parameter sets the font style to apply to the chat interface. | Parameter | Type | Default | Status | | ------------ | ------------------- | ------- | ----------------------------------------- | | `fontFamily` | `string` (optional) | - | Set a font style that needs to be applied | For more information, see [Customizing the chat UI: Styles](customization_ui_configuration#styles). ## New feature ### Enhanced home screen customization Enhanced the [`updateWelcomeScreen()`](methods/updateWelcomeScreen) method with expanded SVG icon format support and improved property behavior. The method now supports three SVG icon formats: base64-encoded data URLs (recommended), external URLs, and inline SVG strings. Added comprehensive documentation covering character limits, line capping behavior, Redux state persistence, and property handling (omitted vs empty string vs null values). For more information, see the documentation for [`updateWelcomeScreen()`](methods/updateWelcomeScreen) method. ### Header customization for agent avatar and name Added `header.showAgentAvatar` and `header.showAgentName` configuration parameters to let you hide the agent avatar and name in the embedded chat header. These parameters provide greater flexibility in customizing the chat interface appearance to match your website's design requirements. Both parameters accept boolean values and default to `true`, so the agent avatar and name are shown unless you explicitly hide them: * `header.showAgentAvatar` Hides the agent avatar in the chat header when set to `false`. * `header.showAgentName` Hides the agent name in the chat header when set to `false`. For more information, see [Customizing the chat UI: Header](customization_ui_configuration#header). ### Restart conversation event enhancements Enhanced [`pre:restartConversation`](events/preRestartConversation) and [`restartConversation`](events/restartConversation) events with the `interactionType` property. This property identifies the source of the restart action, enabling better observability, analytics tracking, and downstream feature control. The `interactionType` parameter provides context about how the conversation restart was triggered: * `restart_button` - Restart triggered by clicking the Restart button in the header * `new_chat_button` - Restart triggered by clicking the New Chat button in the sidebar * `instance_method` - Restart triggered programmatically via the `restartConversation()` instance method This enhancement allows developers to implement different behaviors based on the restart source, track user interactions more accurately, and provide context-aware experiences. ## Documentation improvements ### Event documentation updates for custom message state handling Updated the documentation for [`pre:receive`](events/preReceive) and [`pre:threadLoaded`](events/preThreadLoaded) to clarify how to add custom properties to `message_state.user_defined` by using the spread operator to create a new object reference. Added notes and updated examples to describe how this approach helps preserve existing properties and avoid `Object is not extensible` errors in stricter environments. ## New features ### Message translation support Enhanced [`pre:send`](events/preSend), [`pre:receive`](events/preReceive), and [`pre:threadLoaded`](events/preThreadLoaded) events with message translation capabilities. These enhancements enable real-time translation of user messages and agent responses, allowing users to interact in their preferred language while the agent processes messages in English. ## New features ### Streaming delta event Added the [`pre:stream:delta`](events/preStreamDelta) event for real-time control over streaming responses. This event fires before each streaming delta chunk is processed and rendered, enabling you to inspect, modify, or suppress streaming content as it arrives. For more information, see the documentation for [`pre:stream:delta`](events/preStreamDelta) event. ### Silent messages Added support for silent messages in the [`send()`](methods/send) method. Silent messages are sent to the agent but remain hidden from the chat UI, enabling cleaner user experiences for system notifications and background operations. For more information, see the documentation for [`send()`](methods/send) method. ### Load chat thread Added the `features.showThreadList` configuration parameter to control the visibility of the chat history (thread list) in the side panel. This feature provides flexible control over conversation history display. For more information, see [Customizing the chat UI: Features](customization_ui_configuration#features). ### Dropdown title customization Added the `showSelectedAsTitle` property for dropdown form elements in `float` and `custom` layouts. This property allows the detail view title to automatically update to display the text of the currently selected dropdown item, providing better context for users navigating form interactions. For more information, see the `showSelectedAsTitle` property details in [`updateCustomHeaderItems()`](methods/updateCustomHeaderItems). ## Documentation improvements ### Context variables Added comprehensive [Context variables](context_variables) documentation covering methods for passing additional information from your web application to agents: * **Two implementation methods**: * **JWT token method**: For stable and identity-related context such as user ID, role, and organization. * **Instance methods (`pre:send` event)**: For dynamic and frequently changing context such as current page, form inputs, and selections. * **Complete implementation examples**: * Full JWT creation service with RS256 signing and user payload encryption * Simple and advanced context injection patterns using instance methods * Combined approach demonstrating both methods together * **Agent configuration**: Step-by-step setup including agent definition with `context_access_enabled` and `context_variables` list. ### Instance methods Enhanced the [Instance methods](methods/index) documentation with comprehensive coverage of all chat instance methods: * **Method categories**: Organized methods into Message, User interface, Chat widget state, Security and identity, and Events categories. * **Detailed method reference**: Added complete documentation for all supported instance methods: * [`send()`](methods/send) * [`doAutoScroll()`](methods/doAutoScroll) * [`scrollToMessage()`](methods/scrollToMessage) * [`updateMessageStateUserDefined()`](methods/updateMessageStateUserDefined) * [`restartConversation()`](methods/restartConversation) * [`changeView()`](methods/changeView) * [`updateCustomHeaderItems()`](methods/updateCustomHeaderItems) * [`getCustomHeaderItems()`](methods/getCustomHeaderItems) * [`updateWelcomeScreen()`](methods/updateWelcomeScreen) * [`updateLocale()`](methods/updateLocale) * [`getLocale()`](methods/getLocale) * [`updateAuthToken()`](methods/updateAuthToken) * [`destroy()`](methods/destroy) * [`on()`](methods/on) * [`once()`](methods/once) * [`off()`](methods/off) * **Complete examples**: Added working code examples demonstrating instance method usage patterns with event handlers. * **Runtime control**: Included guidance on programmatically controlling chat behavior, state management, and UI customization. ### Events Enhanced the [Events](events) documentation with comprehensive coverage of all chat events: * **Event categories**: Organized events into Lifecycle, Message, Conversation, View, Customization, Feedback, and Security events categories. * **Detailed event reference**: Added complete documentation for all supported events: * [`chat:ready`](events/chatReady) * [`pre:send`](events/preSend) * [`send`](events/send) * [`pre:stream:delta`](events/preStreamDelta) * [`pre:receive`](events/preReceive) * [`receive`](events/receive) * [`pre:restartConversation`](events/preRestartConversation) * [`restartConversation`](events/restartConversation) * [`pre:threadLoaded`](events/preThreadLoaded) * [`view:pre:change`](events/viewPreChange) * [`view:change`](events/viewChange) * [`view:properties:pre:change`](events/viewPropertiesPreChange) * [`view:properties:change`](events/viewPropertiesChange) * [`userDefinedResponse`](events/userDefinedResponse) * [`customEvent`](events/customEvent) * [`feedback`](events/feedback) * [`authTokenNeeded`](events/authTokenNeeded) * **Complete examples**: Added working code examples demonstrating event usage patterns. * **Best practices**: Included guidance on event handler patterns, modifying event data, and common use cases.