Service Cloud Chat Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
About This Guide
Prerequisites
API Versions
Customize Deployments with the Deployment APIs
Create Deployments
Log Deployment Activity with the Deployment APIs
Customize Your Chat Window with the Deployment APIs
Customize Chat Buttons with the Deployment APIs
Find and Create Records Automatically with the Deployment APIs
Customize Automated Chat Invitations with the Deployment APIs
Deployment API Code Sample
Use Pre-Chat to Gather Visitor Information and Set Context for the Agent
Implement a Custom Chat Window Using Visualforce
Use Post-Chat to Wrap Up the Chat Interaction with Your Customer
Set Up Direct-to-Agent Chat Routing with the Deployment APIs
PDF

Customize Deployments with the Deployment APIs

Customize deployments using the Chat Deployment API.

The legacy chat product is scheduled for retirement on February 14, 2026, and is in maintenance mode until then. During this phase, you can continue to use chat, but we no longer recommend that you implement new chat channels. To avoid service interruptions to your customers, migrate to Messaging for In-App and Web before that date. Messaging offers many of the chat features that you love plus asynchronous conversations that can be picked back up at any time. Learn about chat retirement in Help.

Important

A deployment is a place on your company’s website that’s enabled for Chat. A deployment consists of a few lines of JavaScript that you add to a Web page. Your organization can have a single Chat deployment or multiple deployments. For example, if you have a single service center that supports multiple websites, creating a separate deployment for each site enables you to present multiple chat windows to your visitors. Each deployment includes a chat window, which visitors use to chat with support agents.

The Deployment API is a JavaScript-based API that lets you customize your deployments to specify back-end functionality.