--- schema_version: "1" id: fb207c595a90ad6d459222053cedac9600a0e27462ad6443da2f22f631fd6276 title: Bot collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_bot.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_bot.htm source_site: developer.salesforce.com content_type: documentation content_hash: 80470ef969ae125fca6ed995c30d54f41b6bb73d7dab8041dbccc6c2a9b49235 description: Represents a definition of an Einstein Bot configuration that can have one or more versions. Only one version can be active. --- # Bot Represents a definition of an Einstein Bot configuration that can have one or more versions. Only one version can be active. ## Parent Type 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 Bot components have the suffix .bot and are stored in the bots folder. ## Version Bot components are available in API version 43.0 and later. ## Special Access Rules Bot is available only if Chat and Einstein Bots are enabled in your org. Bot metadata deployment and retrieval are not supported for Lead Nurturing and Sales Coach Agents. ## Fields
Field Name Field Type Description
agentDSLEnabled boolean Reserved for internal use.
agentTemplate string If this Bot represents an agent, this field represents the name of the agent template used to create it. Available in API version 64.0 and later.
agentType GenAiAgentType (enumeration of type string) Specifies the agent type for this agent. For example, AgentforceServiceAgent. Available in API version 64.0 and later.
botMlDomain LocalMlDomain Represents the Einstein intent set that groups intents, entities, and variables associated with a bot. All Einstein Bot versions under the same bot now share an intent set. Available in API version 44.0 and later.
botUser string Specifies the username of the user account, not the first and last name or the user ID. Available in API version 46.0 and later.
botVersions BotVersion Represents the configuration details for a specific Einstein Bots version, including dialogs, intents, entities, and variables.
contextVariables ConversationContextVariable Represents the context variables that enable your bot to gather customer information regardless of channel. Available in API 45.0 and later.
conversationChannelProviders ConversationDefinitionChannelProvider [] Represents a list of the conversation channels linked to the bot. Available in API version 51.0 and later.
defaultOutboundFlow string Specifies a fallback escalation behavior if the primary agent escalation behavior is not available. For example, Agentforce Service Agents can route conversations to human service reps. Available in API version 65.0 and later.
description string A description of the bot.
label string Label that identifies the bot throughout the Salesforce user interface.
logPrivateConversationData boolean Specifies whether to log customer inputs as part of conversation data (true) or not (false). Available in API version 48.0 and later.
pageContextVariables PageContextVariable[] Provides page-level context variables for the bot. Available in API version 64.0 and later.
sessionTimeout int Represents the maximum amount of minutes that a bot session can be idle. Available in API version 58.0 and later.
type BotType (enumeration of type string) Required. The default value is Bot. This field represents the configuration type of the bot. Valid values are:
  • Bot— Default Einstein Bot configuration.
  • ExternalCopilot— An external-facing agent. For example, an Agentforce Service agent.
  • InternalCopilot— An internal-facing agent. For example, an Agentforce Employee agent.
## LocalMlDomain An Einstein Intent Set local to the current bot version. | Field Name | Field Type | Description | | --- | --- | --- | | label | string | Label that represents an Einstein Intent Set local to the current bot version throughout the Salesforce user interface. | | mlIntents | [MlIntent](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_mldomain.htm#MlIntent)\[\] | List of intents associated with this local intent set. | | mlSlotClasses | [MlSlotClass](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_mldomain.htm#MlSlotClass)\[\] | List of entities associated with this local intent set. | | name | string | Required. This unique name prevents conflicts with other local Einstein Intent Sets. This name can contain only underscores and alphanumeric characters and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. | ## ConversationContextVariable A context variable local to the current bot version. Available in API version 45.0 and later.
Field Name Field Type Description
contextVariableMappings ConversationContextVariableMapping Represents the mapping between a context variable, channel type, and sObject field.
dataType ConversationDataType (enumeration of type string) Required. Represents the data type of the context variable. Valid values are:
  • Text
  • Number
  • Boolean
  • Object
  • Date
  • DateTime
  • Currency
  • Id
description string A description of this variable. This value may be used by the Agentforce planner service. Available in API version 63.0 and later.
developerName string Required. Represents the name of the context variable. Can contain only underscores and alphanumeric characters and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.
includeInPrompt boolean Indicates whether the variable is injected into the prompt sent to the Agentforce model. If true, the variable appears in the Included Fields section of the UI.
Note

Note

The default variables Id, EndUserId, and EndUserLanguage always appear in the Included Fields section of the UI, regardless of their value of includeInPrompt. We recommend that you don't change the value of includeInPrompt for these default variables, as changing the value can prevent your agent from accessing important session data.

Available in API version 63.0 and later.
label string Required. A label that identifies the context variable throughout the Salesforce user interface.
SObjectType string Valid values are:
  • BotDefinition
  • Queue
## ConversationContextVariableMapping Represents the mapping between a context variable, channel type, and sObject field.
Field Name Field Type Description
fieldName string Required. The API name of an SObject field to be used as part of the mapping.
messageType MessageType (enumeration of type string) Required. Represents the message channel. Valid values are:
  • Alexa
  • AppleBusinessChat—Messages sent in enhanced Apple Messages for Business channels.
  • Email
  • EmbeddedMessaging—Messages sent in Messaging for In-App and Web channels. Available in API version 50.0 and later.
  • Facebook
  • GoogleChat—Available in API version 68.0 and later.
  • GoogleHome
  • InternalCopilot
  • Line
  • MsCopilot
  • Omega
  • Phone
  • PstnVoice
  • Rcs
  • SipVoice
  • Slack—Available in API version 68.0 and later.
  • Text
  • VoiceIntegrationPilot
  • WeChat
  • WebChat
  • WhatsApp
  • WhatsAppVoice
SObjectType string Required. SObject type for the field property defined as part of the mapping. Valid values are:
  • LiveChatTranscript
  • MessagingEndUser
  • MessagingSession
## ConversationDefinitionChannelProvider The developer name of a conversation channel linked to the bot. Available in API version 51.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png) #### Note To add, edit, or remove a messaging channel, you must use the UI. If you deploy a bot with messaging channel providers, those providers aren’t visible in Metadata API. | Field Name | Field Type | Description | | --- | --- | --- | | agentRequired | boolean | Specifies whether an agent must be online for the bot to be active (true) or not (false) The default is false. | | chatButtonName | string | Required. The developer name of a LiveChatButton metadata component. | ## PageContextVariable A page-level context variable used by the bot. Available in API version 64.0 and later.
Field Name Field Type Description
SObjectType string Specifies the sObject type associated with this page context variable.
dataType ConversationDataType (enumeration of type string) Required. Represents the data type of the page context variable. Valid values are:
  • Text
  • Number
  • Boolean
  • Object
  • Date
  • DateTime
  • Currency
  • Id
description string A description of the page context variable.
developerName string Required. Represents the unique API name of the page context variable. Can contain only underscores and alphanumeric characters and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.
label string Required. A label that identifies the page context variable throughout the Salesforce user interface.
## Declarative Metadata Sample Definition The following is an example of a Bot. This example has been trimmed to make it easier to read. Astros Pizza New\_Order New Order Today is pie day so I want pie Size Value Size en\_US Big Extra Large X-Large Grande Huge Large Astros\_Pizza\_ld1 v1 Order\_Management Order Management Order\_Management 🍕🍕🍕Pizza Time! 🍕🍕🍕 Message Verified\_User ConversationVariable Equals false Customer\_Verification Call Navigation Group Location ConversationVariable IsNotSet Select\_Location Call Navigation Group CreateOrderService apex customer Input Contact ConversationVariable location Input Location ConversationVariable output Output Pizza\_Order ConversationVariable Set VariableOperation Perfect, let's work on your order from our {!Location.Name} location Message Add\_Items\_to\_Order Redirect Navigation New\_Order New Order New\_Order false Object Contact Contact Text Delivery\_Address Delivery Address Object Pizza\_Order Pizza Order Welcome Main\_Menu LiveChatTranscript LiveChatTranscript.ChatKey WebChat Text ChatKey Chat Key LiveChatTranscript LiveChatTranscript.ContactId WebChat Id ContactId Contact Id LiveChatTranscript LiveChatTranscript.LiveChatVisitorId WebChat Id EndUserId End User Id LiveChatTranscript LiveChatTranscript.Id WebChat Id RoutableId Routable Id .... false Chat\_Button\_For\_Bot Astro's Pizza The following is an example package.xml that references the previous definition. Pizza\_Bot Bot 45.0 ## 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).