Botium Connector for Salesforce Einstein Bots
MIT License
This is a Botium connector for testing your Salesforce Einstein chatbot.
Did you read the Botium in a Nutshell articles? Be warned, without prior knowledge of Botium you won't be able to properly use this library!
Botium connects to your Einstein chatbot using the Salesforce Live Agent REST API.
It can be used as any other Botium connector with all Botium Stack components:
When using Botium CLI:
> npm install -g botium-cli
> npm install -g botium-connector-einsteinbot
> botium-cli init
> botium-cli run
When using Botium Bindings:
> npm install -g botium-bindings
> npm install -g botium-connector-einsteinbot
> botium-bindings init mocha
> npm install && npm run mocha
When using Botium Box:
Already integrated into Botium Box, no setup required
You have to collect some information from your Salesforce instance - see capabilities description below.
Create a botium.json in your project directory, filling in the required information:
{
"botium": {
"Capabilities": {
"PROJECTNAME": "<whatever>",
"CONTAINERMODE": "einsteinbot",
"EINSTEINBOT_ENDPOINT": "xxx",
"EINSTEINBOT_ORGANIZATION_ID": "xxx",
"EINSTEINBOT_DEPLOYMENT_ID": "xxx",
"EINSTEINBOT_CHATBUTTON_ID": "xxx"
}
}
}
To check the configuration, run the emulator (Botium CLI required) to bring up a chat interface in your terminal window:
> botium-cli emulator
Botium setup is ready, you can begin to write your BotiumScript files.
The Live Chat Transcripts generated by the Botium Tests will count against your Salesforce data storage limits (check it in Service Setup | Settings | Data | Storage Usage). To delete it you can use the Salesforce Dataloader, or if you don't want to install it:
Set the capability CONTAINERMODE to einsteinbot to activate this connector.
Chat API Endpoint
Find it in Salesforce: Service Setup | Channels | Chat | Chat-Settings
Organization Id
Find it in Salesforce: Setup | Company Settings | Company information
Deployment Id
Find it in Salesforce: Service Setup | Channels | Chat | Deployments, click on deployment and get it from the page url (address=%2F)
Chatbot Button Id
Find it in Salesforce: Service Setup | Channels | Chat | Chat Buttons, click on button and get it from the page url (address=%2F)
Visitor name (optional)
Visitor name to be used for the Botium conversations