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 Metadata and inherits its fields.

LiveChatDeployment values are stored in the <developer_name>.liveChatDeployment file in the liveChatDeployments directory.

Introduced in API version 28.0.

  • Type: string
  • Required: No
  • Description: Specifies the branding image for the deployment.
  • Type: int
  • Required: No
  • Description: Indicates the amount of time before the chat times out, in seconds.
  • Type: int
  • Required: No
  • Description: Indicates the amount of time before a time-out warning is displayed to the agent, in seconds.
  • Type: boolean
  • Required: No
  • Description: (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.
  • Type: boolean
  • Required: No
  • Description: Indicates whether or not the pre-chat API is enabled for the deployment (true) or not (false).
  • Type: boolean
  • Required: No
  • Description: Indicates whether chat transcripts are automatically saved after a chat ends (true) or not (false).
  • Type: string
  • Required: Yes
  • Description: Specifies the name of the deployment.
  • Type: string
  • Required: No
  • Description: Specifies the branding image for the deployment that appears when customers access the deployment on a mobile device.
  • Type: string
  • Required: No
  • Description: 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.
  • Type: string
  • Required: Yes
  • Description: Specifies the title of the window associated with the deployment.

Represents a Chat deployment’s domain whitelist.

  • Type: string[]
  • Required: No
  • Description: Specifies a domain that can host the deployment.

This is a sample of a liveChatDeployment file.

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

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.