Customize Chat Buttons with the Deployment APIs

Each chat button includes code that you place on your website to let customers start a chat. Chat automatically handles the button's availability based on your agents’ availability and your org's settings. It also handles starting the chat request from the button.

Use the following deployment methods to customize your chat buttons and starting chats. You can add any of these methods as additional scripts within the code that’s automatically generated when you create a deployment.

showWhenOnline
Use the showWhenOnline method to specify what customers see when a particular button is online.
showWhenOffline
Use the showWhenOffline method to specify what customers see when a particular button is offline.
addButtonEventHandler
Use the addButtonEventHandler method to define a chat button’s behavior when certain events occur. Available in API versions 28.0 and later.
startChat
Use the startChat method to request a chat from a button in a new window.
startChatWithWindow
Use the startChatWithWindow method to request a chat from a button using the name of a window.
Corresponding Calls for Chat Buttons
Make sure your chats start correctly by aligning your calls when using buttons, direct-to-agent, and agent with fallback-to-button.

Service Cloud Chat Developer Guide

See Also