Embedded Service Chat for Web Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Embedded Service Chat for Web Developer Guide
Adjust General Parameters
Change the Embedded Chat Window Appearance and Behavior
Customize Embedded Chat
Customize the Channel Menu
Embedded Service Customized Components
Lightning Web Components for Embedded Service
Custom Aura Components
Multiple Components with Lightning Out
Code Snippet Versions
PDF

Lightning Web Components for Embedded Service

Build custom chat components using Lightning Web Components in Embedded Service, which is supported in Lightning Out, Experience Cloud, and Essentials. Leverage HTML and JavaScript for a modern experience.

The legacy chat product is in maintenance-only mode, and we won't continue to build new features. You can continue to use it, but we no longer recommend that you implement new chat channels. Instead, you can modernize your customer communication with Messaging for In-App and Web. Messaging offers many of the chat features that you love plus asynchronous conversations that can be picked back up at any time.

Important

Embedded Service web components aren’t supported on the login page of Experience sites.

Note

Base Chat Header

lightningsnapin-base-chat-header enables customizations of the chat window header. Your custom chat header component must import BaseChatHeader from the lightningsnapin/baseChatHeader module, extend BaseChatHeader, and specify the lightningSnapin__ChatHeader target in the js-meta.xml configuration file.

For more detailed information, see Base Chat Header in the Components Reference Guide.

Base Chat Message

lightningsnapin-base-chat-messageenables customizations of the user interface for chat messages. Your custom chat message component must import the BaseChatMessage from the lightningsnapin/baseChatMessage module, extend BaseChatMesssage, and specify the lightningSnapin__ChatMessage target in the js-meta.xml configuration file.

For more detailed information, see Base Chat Message in the Lightning Web Components Reference Guide.

Base Pre-Chat

lightningsnapin-base-prechat enables customization of the user interface for the pre-chat form. Your pre-chat component imports BasePreChat from the lightningsnapin/basePrechat module, extendsBasePreChat, and specifies the lightningSnapin__PreChat target in the js-meta.xml configuration file.

For more detailed information, see Pre-Chat Message in the Lightning Web Components Reference Guide.

Minimized

lightningsnapin-minimized enables customization of the user interface for the chat minimized state. Your minimized component uses assignHandler and minimize functions from the lightningsnapin/minimized module and should specify the lightningSnapin__Minimized target in the je-meta.xml configuration file.

For more detailed information, see Minimized Chat Message in the Lightning Web Components Reference Guide.