BotVersion

Represents the configuration details for a specific Einstein Bot version, including dialogs and variables.

This type extends Metadata and inherits its fields.

BotVersion components have the suffix .bot and are stored in the bot folder. BotVersion is a top-level child of Bot and shares its suffix and file directory.

Introduced in API version 43.0.

BotVersion 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.

  • Type: boolean
  • Required: No
  • Type: BotDialogGroup[]
  • Required: No
  • Description: The list of dialog groups in this bot version.
  • Type: BotDialog[]
  • Required: No
  • Description: The list of dialogs in this bot version.
  • Type: boolean
  • Required: No
  • Type: string
  • Required: No
  • Description: Reserved for internal use.
  • Type: ConversationVariable[]
  • Required: No
  • Introduced: API version 44.0
  • Description: A container that stores a specific piece of data collected from the customer. You can use variables within dialog actions as both inputs and outputs.
  • Type: Language (enumeration of type string)
  • Required: No
  • Description: Represents the primary language of a Copilot or Agent.
  • Type: string
  • Required: No
  • Description: Reserved for internal use.
  • Type: boolean
  • Required: No

  • Type: string

  • Required: Yes

  • Description: Required.

    A reference to the first dialog that the bot presents to your customer. For example, Welcome.

  • Type: boolean
  • Required: No
  • Description: Reserved for internal use.
  • Type: boolean
  • Required: No
  • Description: Reserved for internal use.

  • Type: double

  • Required: No

  • Introduced: API version 63.0

  • Description: Specifies how strictly a user message must match with a bot intent.

    Valid values are between 1 and 5, where 1 is the least strict and 5 is the most strict.

    To turn on this feature, contact Salesforce Customer Support.

  • Type: boolean
  • Required: No
  • Description: Reserved for internal use.
  • Type: boolean
  • Required: No
  • Type: boolean
  • Required: No
  • Description: Indicates whether a knowledge action is enabled. The default value is false.
  • Type: boolean
  • Required: No
  • Description: Reserved for internal use.
  • Type: string
  • Required: No
  • Description: A reference to the dialog identified as the main menu dialog. For example, Main Menu.
  • Type: int
  • Required: No
  • Description: An optional default or custom delay after every bot response to simulate typing.
  • Type: string
  • Required: No
  • Description: Reserved for internal use.
  • Type: boolean
  • Required: No
  • Type: boolean
  • Required: No
  • Type: boolean
  • Required: No
  • Type: boolean
  • Required: No
  • Type: boolean
  • Required: No
  • Description: Reserved for internal use.
  • Type: GenAiBotToneType (enumeration of type string)
  • Required: No
  • Description: The tone of the bot.
  • Possible values:
    • Casual
    • Formal
    • Neutral

The list of dialogs in this bot version.

  • Type: string
  • Required: No
  • Description: The bot dialog group that contains this bot dialog.
  • Type: BotStep[]
  • Required: No
  • Description: A list of steps that are executed as part of the dialog.
  • Type: string
  • Required: No
  • Description: A description of the bot dialog.

  • Type: string

  • Required: Yes

  • Description: Required.

    This unique name prevents conflicts with other dialogs associated with the same bot version. This name can contain only underscores and alphanumeric characters. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.

Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field.
  • Type: boolean
  • Required: No
  • Introduced: API version 58.0
  • Description: In a bot block, indicates whether a dialog is a placeholder (true) or not (false). In a bot template or bot version not associated with a bot block, this field is read-only and the value is false.

  • Type: string

  • Required: Yes

  • Description: Required.

    A label that identifies the dialog throughout the Salesforce user interface.

  • Type: string

  • Required: No

  • Description: Required.

    A label that identifies the dialog throughout the Salesforce user interface. The name of the intent associated with a dialog.

  • Type: boolean
  • Required: No
  • Introduced: API version 46.0
  • Description: Indicates whether Einstein is turned on to train an intent model for the dialog intent (true) or turned off for the exact match option (false). The default value is false.
  • Type: boolean
  • Required: No
  • Description: Indicates whether to show this dialog in the Bot Options menu. The default value is false.

The list of dialog groups in this bot version.

  • Type: string
  • Required: No
  • Description: A description of the bot dialog group.

  • Type: string

  • Required: Yes

  • Description: Required.

    This unique name prevents conflicts with other dialog groups associated with the same bot version. This name can contain only underscores and alphanumeric characters. The name must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.

Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field.

  • Type: string

  • Required: Yes

  • Description: Required.

    A label that identifies the dialog group throughout the Salesforce user interface.

Bot Invocation used by a BotStep of type Invocation.

  • Type: string
  • Required: No
  • Description: The name of the invocable action used by a Bot Invocation.

  • Type: ConversationInvocableTargetType (enumeration of type string)

  • Required: No

  • Description: Available dialog action types are:

    Values are:

  • Possible values:

    • apex
    • externalService — (Available in API version 53.0 and later.)
    • flow
    • logFeedback — (Available in API version 51.0 and later.)
    • logGoalAchieved — (Deprecated in API version 57.0 and later.)
    • standardInvocableAction
  • Type: BotInvocationMapping[]
  • Required: No
  • Description: List of Bot Invocation Mappings for a Bot Invocation.

List of Bot Invocation Mappings for a Bot Invocation.

  • Type: string

  • Required: Yes

  • Description: Required.

    Name of an Input/Output parameter of the parent Bot Invocation target.

  • Type: string
  • Required: No
  • Introduced: API version 54.0
  • Description: Name of the record that is used as part of an Invocation mapping.

  • Type: BotInvocationMappingType (enumeration of type string)

  • Required: Yes

  • Description: Required.

    Values are:

  • Possible values:

    • Input
    • Output
  • Type: string
  • Required: No
  • Description: Literal value to be assigned to the specified parameter.
  • Type: string
  • Required: No
  • Description: Name of the Bot Variable that is used as part of an Invocation mapping.

  • Type: ConversationVariableType (enumeration of type string)

  • Required: No

  • Description: This field relates to the type of variable used in this invocation mapping.

    Values are:

  • Possible values:

    • ContextVariable
    • ConversationVariable
    • PageContextVariable

A bot message used by a BotStep of type Message.

  • Type: string

  • Required: Yes

  • Description: Required.

    Message to display as part of an outgoing message from the bot to the customer.

  • Type: string
  • Required: No
  • Introduced: API version 53.0
  • Description: A unique key that identifies a message within a dialog. It is used to link translated labels to labels within the message. This field is recommended for all message records and is required for translated message labels. If a message is created via the UI, the messageIdentifier is automatically generated. If a message is created via API, the messageIdentifier must be provided. messageIdentifier can contain letters, numbers, dashes, and underscores, up to 255 characters.

Bot navigation used by a BotStep of type Navigation.

  • Type: BotNavigationLink[]
  • Required: No
  • Description: List of Bot Navigation links associated with a Bot Navigation of type Call or Redirect.

  • Type: BotNavigationType (enumeration of type string)

  • Required: Yes

  • Description: Required.

    Values are:

  • Possible values:

    • Call
    • Redirect
    • TransferToAgent

List of Bot Navigation links associated with a Bot Navigation of type Call or Redirect.

  • Type: string
  • Required: No
  • Description: Label displayed when more than one Bot Navigation Link is available under a Bot Navigation of type Redirect. The target dialog label is used when no label is provided.
  • Type: string
  • Required: No
  • Description: Name of the target dialog to be called as part of this Bot Navigation Link.
  • Type: string
  • Required: No
  • Introduced: API version 57.0
  • Description: In the Redirect to Dialog Rule Action, the ID of the target object variable to be called as part of this Bot Navigation link.
  • Type: ConversationVariableType (enumeration of type string)
  • Required: No
  • Introduced: API version 57.0
  • Description: In the Redirect to Dialog Rule Action, the type of variable referred to in targetVariable. Values are:
  • Possible values:
    • ContextVariable
    • ConversationVariable
    • PageContextVariable

List of static choice options used by a bot variable operation of type Collect and quickReplyType of Static.

  • Type: string

  • Required: Yes

  • Description: Required.

    Value to be displayed as a menu or button choice to your customer.

  • Type: string
  • Required: No
  • Introduced: API version 53.0
  • Description: A unique key that identifies a quick reply option within a dialog. It is used to link translated labels to labels within the quick reply option. This field is recommended for all quick reply option records and is required for translated quick reply option labels. If a quick reply option is created via the UI, the quickReplyOptionIdentifier is automatically generated. If a message is created via API, the quickReplyOptionIdentifier must be provided. quickReplyOptionIdentifier can contain letters, numbers, dashes, and underscores, up to 255 characters.

A step that is executed as part of the dialog.

  • Type: string
  • Required: No
  • Description: This field is reserved for future use.
  • Type: BotInvocation
  • Required: No
  • Description: Bot Invocation used by a BotStep of type Invocation.
  • Type: BotMessage[]
  • Required: No
  • Description: List of bot messages used by a BotStep of type Message.
  • Type: BotNavigation
  • Required: No
  • Description: Bot Navigation used by a BotStep of type Navigation.
  • Type: BotStepCondition[]
  • Required: No
  • Description: List of BotStep conditions associated with a BotStep of type Group.
  • Type: BotStep[]
  • Required: No
  • Description: List of BotSteps associated to a Bot Step of type Group.
  • Type: BotVariableOperation
  • Required: No
  • Description: Bot Variable Operation used by a BotStep of type VariableOperation.
  • Type: ConversationDefinitionLogicalOperatorType (enumeration of type string)
  • Required: No
  • Description: Represents the type of conditional logic used by a BotStep. Values are: Available in API version 58.0 and later.
  • Possible values:
    • And
    • Or
  • Type: ConversationRecordLookup
  • Required: No
  • Introduced: API version 46.0
  • Description: A lookup action to the Conversation record.
  • Type: ConversationSystemMessage
  • Required: No
  • Introduced: API version 46.0
  • Description: System messages that represent an action for a BotStep, such as transferring to an agent or ending a chat.
  • Type: ConversationDefinitionRichMessage
  • Required: No
  • Introduced: API version 54.0
  • Description: List of configuration details used by a BotStep that references a messaging component.
  • Type: string
  • Required: No
  • Introduced: API version 53.0
  • Description: A unique key that identifies a step within a dialog. It is used to link translated labels to labels within the step. This field is recommended for all step records and is required for translated step labels. If a step is created via the UI, the stepIdentifier is automatically generated. If a step is created via API, the stepIdentifier must be provided. The stepIdentifier can contain letters, numbers, dashes, and underscores, up to 255 characters.

  • Type: BotStepType (enumeration of type string)

  • Required: Yes

  • Description: Required.

    Values are:

  • Possible values:

    • GoalStep — (Available in API version 57.0 and later.)
    • Group
    • Invocation
    • Message
    • Navigation
    • RecordLookup — (Available in API version 48.0 and later.)
    • RichMessage — (Available in API version 54.0 and later.)
    • SystemMessage
    • VariableOperation
    • Wait

List of BotStep conditions associated with a BotStep of type Group.

  • Type: string

  • Required: Yes

  • Description: Required.

    Name of the variable used as the left side of the condition operation.

  • Type: ConversationVariableType (enumeration of type string)

  • Required: Yes

  • Description: Required.

    Type of the variable used as the left side of the condition operation.

    Values are:

  • Possible values:

    • ContextVariable
    • ConversationVariable
    • PageContextVariable

  • Type: BotStepConditionOperatorType (enumeration of type string)

  • Required: Yes

  • Description: Required.

    Values are:

  • Possible values:

    • Equals
    • GreaterThan — (Available in API version 47.0 and later.)
    • GreaterThanOrEqualTo — (Available in API version 47.0 and later.)
    • IsNotSet
    • IsSet
    • LessThan — (Available in API version 47.0 and later.)
    • LessThanOrEqualTo — (Available in API version 47.0 and later.)
    • NotEquals
  • Type: string
  • Required: No
  • Description: Value that is used as the right side of the condition operation. This value is ignored when using IsSet and IsNotSet operators.

List of bot variable operands associated with a bot variable of type Set or Unset.

  • Type: boolean
  • Required: No
  • Description: Disables auto-fill behavior for a bot variable under a bot variable operation of type Collect.
  • Type: string
  • Required: No
  • Description: Name of the source CustomField or MlSlotClass used in the variable operation.
  • Type: ConversationVariableOperandSourceType (enumeration of type string)
  • Required: No
  • Description: Values are:
  • Possible values:
    • BotDefinition — (Available in API version 46.0 and later.)
    • ContextVariable — (Available in API version 45.0 and later.)
    • ConversationVariable
    • FlowDefinition — (Available in API version 52.0 and later.)
    • MlSlotClass
    • Queue — (Available in API version 46.0 and later.)
    • StandardConversationVariable
    • StandardMlSlotClass
    • Value
  • Type: string
  • Required: No
  • Description: Literal value used as the source for this variable operation.

  • Type: string

  • Required: Yes

  • Description: Required.

    Name of the target variable used in the variable operation.

  • Type: ConversationVariableType (enumeration of type string)

  • Required: Yes

  • Description: Required.

    Type of the target used in the variable operation.

    Values are:

  • Possible values:

    • ContextVariable
    • ConversationVariable
    • PageContextVariable

Bot variable operation used by a BotStep of type VariableOperation.

  • Type: boolean
  • Required: No
  • Introduced: API version 51.0
  • Description: If true, the bot runs a Bot Variable Operation of type Collect regardless of whether the variable already has a value. When a value exists for a variable, the bot asks the user for the relevant information, and the bot overwrites the existing value with the user-provided value. If false, the bot skips variables with an existing value and maintains the existing value. The default is false.
  • Type: boolean
  • Required: No
  • Introduced: API version 51.0
  • Description: If true, the bot automatically selects the answer in the conversation flow when only one button choice is available in a Bot Variable Operation of type Collect and a quickReplyType value of Dynamic. If false, the bot presents the single button choice and waits for the user’s response. The default is false.
  • Type: BotInvocation
  • Required: No
  • Description: Bot Invocation used to provide Dynamic choices by a Bot Variable Operation of type Collect and quickReplyType of Dynamic.
  • Type: BotMessage[]
  • Required: No
  • Description: List of Bot Messages used as prompt messages by a Bot Variable Operation of type Collect.
  • Type: BotQuickReplyOption[]
  • Required: No
  • Description: List of static choice options used by a Bot Variable Operation of type Collect and quickReplyType of Static.
  • Type: BotVariableOperand[]
  • Required: No
  • Description: List of Bot Variable Operands associated with a Bot Variable of type Set or Unset.
  • Type: boolean
  • Required: No
  • Introduced: API version 63.0
  • Description: If true the bot requires a response to a Question dialog step. The bot doesn’t perform intent recognition for any user messages that do not fit the entity requirements. The bot repeats the question until the customer’s response fits the entity requirements.
  • Type: BotNavigation
  • Required: No
  • Description: Bot Navigation used by a Bot Variable Operation of type Collect. This navigation is executed when the associated Bot Invocation doesn’t return any options.
  • Type: ConversationDefinitionRichMessage
  • Required: No
  • Introduced: API version 58.0
  • Description: Configuration details that reference a messaging component. Outputs are used by a Bot Variable Operation of type Set.
  • Type: boolean
  • Required: No
  • Introduced: API version 48.0
  • Description: If true, the bot asks the repair attempts once and then moves on to the next dialog step. The default value is false.
  • Type: string
  • Required: No
  • Description: Formula template used to resolve a label for Dynamic choice options of type Object.
  • Type: BotQuickReplyType (enumeration of type string)
  • Required: No
  • Description: Values are:
  • Possible values:
    • Dynamic
    • Static
  • Type: BotWidgetType (enumeration of type string)
  • Required: No
  • Description: Values are:
  • Possible values:
    • Buttons
    • Menu
  • Type: string
  • Required: No
  • Introduced: API version 47.0
  • Description: Name of the source VariableName used in the variable operation.

  • Type: ConversationVariableType (enumeration of type string)

  • Required: No

  • Description: This name defines the data type of VariableName used in the variable operation.

    Values are:

  • Possible values:

    • ContextVariable
    • ConversationVariable
    • PageContextVariable
  • Type: BotMessage[]
  • Required: No
  • Introduced: API version 57.0
  • Description: In a File dialog step, the message displayed to the customer as part of type CollectAttachment to confirm a successful file upload.

  • Type: BotVariableOperationType (enumeration of type string)

  • Required: Yes

  • Description: Required.

    Values are:

  • Possible values:

    • Collect
    • CollectAttachment — (Available in API version 57.0 and later.)
    • Set
    • SetConversationLanguage — (Available in API version 53.0 and later.)
    • Unset
  • Type: string
  • Required: No
  • Introduced: API version 53.0
  • Description: A unique key that identifies a variable operation within a dialog. It is used to link translated labels to labels within the variable operation. This field is recommended for all variable operation records and is required for translated variable operation labels. If a variable operation is created via the UI, the variableOperationIdentifier is automatically generated. If a variable operation is created via API, the variableOperationIdentifier must be provided. variableOperationIdentifier can contain letters, numbers, dashes, and underscores, up to 255 characters.

A goal included in the bot version.

Introduced in API version 57.0.

  • Type: string

  • Required: Yes

  • Description: Required.

    A unique name that prevents conflicts with other goals associated with the same bot version. This name can contain only underscores and alphanumeric characters. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.

  • Type: string

  • Required: Yes

  • Description: Required.

    A label that identifies the goal throughout the Salesforce user interface. This label can contain only underscores and alphanumeric characters. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.

Defines the natural language service that is used for the language assigned to a bot version.

Introduced in API version 49.0.

  • Type: Language (enumeration of type string)

  • Required: No

  • Description: Required.

    The language assigned to a bot version.

  • Type: string
  • Required: No
  • Description: If nlpProviderType is EinsteinAI, this field is blank. If Apex, this field holds the Apex class name of the service.

  • Type: ConversationDefinitionNlpProviderType (enumeration of type string)

  • Required: Yes

  • Description: Required.

    Default value is EinsteinAi.

  • Possible values:

    • EinsteinAi
    • Apex

Represents the API name for the Agent planner service.

Introduced in API version 60.0.

  • Type: string
  • Required: Yes
  • Description: The name of an agent planner service that uses a large language model (LLM) and a reasoning strategy to decompose a given task into smaller subtasks, identify the most suitable actions for each subtask, and invoke them.

Represents the configuration details for referencing a messaging component, such as an enhanced link.

Introduced in API version 54.0.

  • Type: ConversationMessageExecutionType (enumeration of type string)
  • Required: No

  • Type: BotInvocationMapping[]

  • Required: No

  • Description: List of mappings for referencing a messaging component. Includes any input parameters and their values. Optionally, specifies the conversation variable for storing any outputs.

    Input parameter values can be either static values or references to conversation or context variables.

  • Type: string

  • Required: Yes

  • Description: Required.

    The API name of the messaging component referenced by the bot.

Represents the association between a goal and a BotStep. A goal can be associated with only one BotStep and one dialog at a time.

Introduced in API version 57.0.

  • Type: string
  • Required: Yes
  • Description: The API name of the goal.

Information related to the linked conversation. Currently only works on Lightning Knowledge.

Introduced in API version 46.0.

  • Type: string (enumeration of type string)

  • Required: No

  • Description: The logical operator that connects the conditions.

    Values are:

    Available in API version 51.0 and later.

  • Possible values:

    • And
    • Or

  • Type: int

  • Required: Yes

  • Description: Required.

    The maximum number of records to return (1-3).

  • Type: string

  • Required: Yes

  • Description: Required.

    Specifies the SObjectType of the ID stored in a bot variable.

  • Type: string
  • Required: No
  • Introduced: API version 51.0
  • Description: The name of the field used to sort the lookup results.

  • Type: SortOrder (enumeration of type string)

  • Required: No

  • Description: The display order of the lookup results.

    Values are:

    Available in API version 51.0 and later.

  • Possible values:

    • Asc
    • Desc
  • Type: string
  • Required: No
  • Description: The input for this lookup operation.

  • Type: ConversationVariableType (enumeration of type string)

  • Required: No

  • Description: Type of the target used in the variable operation.

    Values are:

  • Possible values:

    • ContextVariable
    • ConversationVariable
    • PageContextVariable

  • Type: string

  • Required: Yes

  • Description: Required.

    The variable that holds the results of this lookup.

List of conditions associated with a ConversationRecordLookup.

Introduced in API version 51.0.

  • Type: string

  • Required: Yes

  • Description: Required.

    Field on which the condition operation takes place.

  • Type: string (enumeration of type string)

  • Required: Yes

  • Description: Required.

    The operator applied to the leftOperand.

    Values are:

  • Possible values:

    • Equals
    • NotEquals
    • IsSet
    • IsNotSet
    • GreaterThan
    • LessThan
    • GreaterThanOrEqualTo
    • LessThanOrEqualTo
  • Type: string
  • Required: No
  • Description: The name of the variable to compare against.

  • Type: ConversationVariableType (enumeration of type string)

  • Required: No

  • Description: The type of the variable to compare against.

    Values are:

  • Possible values:

    • ContextVariable
    • ConversationVariable
    • PageContextVariable
  • Type: string
  • Required: No
  • Description: The custom value to compare against. This value is ignored when using IsSet and IsNotSet operators.

  • Type: int

  • Required: Yes

  • Description: Required.

    Order in which the conditions are applied.

The fields used in a conversation record lookup.

Introduced in API version 46.0.

  • Type: string

  • Required: Yes

  • Description: Required.

    Defines the field names used in the Conversation Lookup function.

A system function assigned to a dialog.

Introduced in API version 48.0.

  • Type: string
  • Required: Yes
  • Description: The dialog name triggered when this system event fires.
  • Type: ConversationSystemDialogType (enumeration of type string)
  • Required: Yes
  • Description: The type of system event. Required.
  • Possible values:
    • Disambiguation — (Reserved for Future Use)
    • DisambiguationFailed — (Reserved for Future Use)
    • ErrorHandling
    • KnowledgeAction — (Available in API version 60.0.)
    • KnowledgeFallback — (Available in API version 51.0.)
    • TransferFailed

System messages that represent an action for a Bot Step, such as transferring to an agent or ending a chat.

Introduced in API version 46.0.

  • Type: ConversationSystemMessageType (enumeration of type string)

  • Required: Yes

  • Description: Required.

    This field defines the values available for a system message.

    Values are:

  • Possible values:

    • EndChat
    • Transfer

List of mappings that indicate additional information provided for the system message.

Introduced in API version 46.0.

  • Type: ConversationMappingType (enumeration of type string)

  • Required: Yes

  • Description: Required.

    Defines the type of mapping used in the record.

    Values are:

  • Possible values:

    • Input
    • Output

  • Type: ConversationSystemMessageParamType (enumeration of type string)

  • Required: Yes

  • Description: Required.

    Defines the type of parameter the value is mapped to.

    Values are:

  • Possible values:

    • Transfer

  • Type: string

  • Required: Yes

  • Description: Required.

    Name of the variable that contains the value passed to the system message.

A container that stores a specific piece of data collected from the customer. You can use variables within dialog actions as both inputs and outputs.

Introduced in API version 44.0.

  • Type: ConversationVariableCollectionType (enumeration of type string)
  • Required: No
  • Description: This field defines whether a variable is designated as a List Variable. Valid value is List.
  • Type: ConversationDataType (enumeration of type string)
  • Required: Yes
  • Description: Required.
  • Possible values:
    • Boolean
    • Currency
    • Date
    • DateTime
    • Id — (available in API 45.0 and later.)
    • Object
    • Number
    • Text
  • Type: string
  • Required: No
  • Introduced: API version 63.0
  • Description: A description of this variable. This value may be used by the Agentforce planner service.

  • Type: string

  • Required: Yes

  • Description: Required.

    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. Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field.

  • Type: boolean
  • Required: No
  • Introduced: API version 63.0
  • Description: 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.

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.

  • Type: string

  • Required: Yes

  • Description: Required.

    Label that identifies a variable throughout the Salesforce user interface.

  • Type: string (enumeration of type string)
  • Required: No
  • Description: Specifies the SObjectType of the ID stored in a bot variable.
  • Possible values:
    • BotDefinition
    • Queue
  • Type: ConversationVariableVisibilityType (enumeration of type string)
  • Required: No
  • Description: Required. Determines which components can set this variable. If the visibility is internal, the variable can only be set by action outputs. If the visibility is external, the variable can also be set by the API.
  • Possible values:
    • internal
    • external

This type extends Metadata and inherits its fields.

  • Type: string
  • Required: No

The following is an example of a BotVersion.

The following is an example package.xml that references the previous definition.

This metadata type doesn’t support 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.