---
schema_version: "1"
id: 287fe5c1193f6811eb464c2d49d68beaf595ebe39e5443cf5edc4b09df2e7f62
title: LiveChatDeployment
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_livechatdeployment.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_livechatdeployment.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 05148187c13b7875e322eaeec2643fa5af3b3e13663269083dbacb99d2e499ae
description: Represents the configuration settings for a specific Chat deployment, such as the branding image for the deployment and whether or not chat transcripts are automatically saved.
---
# LiveChatDeployment

Represents the configuration settings for a specific Chat deployment, such as the branding image for the deployment and whether or not chat transcripts are automatically saved.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

LiveChatDeployment values are stored in the <developer\_name>.liveChatDeployment file in the liveChatDeployments directory.

## Version

LiveChatDeployment is available in API version 28.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| brandingImage | string | Specifies the branding image for the deployment. |
| connectionTimeoutDuration | int | Indicates the amount of time before the chat times out, in seconds. |
| ConnectionWarningDuration | int | Indicates the amount of time before a time-out warning is displayed to the agent, in seconds. |
| displayQueuePosition | boolean | (Pilot) Determines whether a customer’s queue position is displayed in a standard chat window while the customer waits for an agent to respond to the chat request (true) or not (false). This field is available as a pilot in API version 32.0. To enable this field, contact Salesforce. |
| domainWhiteList | [LiveChatDeploymentDomainWhiteList](#livechatdeploymentwhitelist) | Specifies the list of domains that can host the deployment. |
| enablePrechatApi | boolean | Indicates whether or not the pre-chat API is enabled for the deployment (true) or not (false). |
| enableTranscriptSave | boolean | Indicates whether chat transcripts are automatically saved after a chat ends (true) or not (false). |
| label | string | Specifies the name of the deployment. |
| mobileBrandingImage | string | Specifies the branding image for the deployment that appears when customers access the deployment on a mobile device. |
| site | string | Specifies the site that hosts the images for the deployment. You must have the CustomDomain permission enabled in your organization before you can use a Salesforce site with Chat. |
| windowTitle | string | Specifies the title of the window associated with the deployment. |

## LiveChatDeploymentDomainWhiteList

Represents a Chat deployment’s domain whitelist.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| domain | string | Specifies a domain that can host the deployment. |

## Declarative Metadata Sample Definition

This is a sample of a liveChatDeployment file.

<?xml version="1.0" encoding="UTF-8"?>
<LiveChatDeployment xmlns="http://soap.sforce.com/2006/04/metadata">
    <label\>My Deployment 1</label\>
    <brandingImage\>pkb\_image\_bannerBg</brandingImage\>
    <mobileBrandingImage\>pkb\_image\_bgBottom</mobileBrandingImage\>
    <domainWhiteList\>
        <domain\>mydomain</domain\>
        <domain\>test</domain\>
    </domainWhiteList\>
    <enableTranscriptSave\>true</enableTranscriptSave\>
    <site\>GL\_Knowledge\_Base</site\>
    <windowTitle\>My window title</windowTitle\>
</LiveChatDeployment\>

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

If you update your deployment through the Metadata API, be sure to update all Web pages that use the same deployment code.

## Wildcard Support in the Manifest File

This metadata type supports the wildcard character \* (asterisk) in the package.xml manifest file. For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).