{"id":15524358,"url":"https://github.com/codeforequity-at/botium-connector-einsteinbot","last_synced_at":"2025-04-23T07:31:31.217Z","repository":{"id":91176406,"uuid":"293496870","full_name":"codeforequity-at/botium-connector-einsteinbot","owner":"codeforequity-at","description":"Botium Connector for Salesforce Einstein Bots","archived":false,"fork":false,"pushed_at":"2021-09-14T06:37:09.000Z","size":50,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-29T22:41:19.177Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/codeforequity-at.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-09-07T10:33:07.000Z","updated_at":"2025-01-24T10:39:57.000Z","dependencies_parsed_at":null,"dependency_job_id":"1b3cf613-be76-491d-b850-7f5acd177ed1","html_url":"https://github.com/codeforequity-at/botium-connector-einsteinbot","commit_stats":{"total_commits":8,"total_committers":1,"mean_commits":8.0,"dds":0.0,"last_synced_commit":"c0e8ebceef00d4d4c0380ae754686293c7e19a02"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-einsteinbot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-einsteinbot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-einsteinbot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-einsteinbot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codeforequity-at","download_url":"https://codeload.github.com/codeforequity-at/botium-connector-einsteinbot/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248610345,"owners_count":21132921,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-02T10:51:03.964Z","updated_at":"2025-04-23T07:31:31.194Z","avatar_url":"https://github.com/codeforequity-at.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Botium Connector for Einstein Bots\n\n[![NPM](https://nodei.co/npm/botium-connector-einsteinbot.png?downloads=true\u0026downloadRank=true\u0026stars=true)](https://nodei.co/npm/botium-connector-einsteinbot/)\n\n[![Codeship Status for codeforequity-at/botium-connector-einsteinbot](https://app.codeship.com/projects/9ba53c50-d343-0138-9788-0add58eace64/status?branch=master)](https://app.codeship.com/projects/408315)\n[![npm version](https://badge.fury.io/js/botium-connector-einsteinbot.svg)](https://badge.fury.io/js/botium-connector-einsteinbot)\n[![license](https://img.shields.io/github/license/mashape/apistatus.svg)]()\n\nThis is a [Botium](https://github.com/codeforequity-at/botium-core) connector for testing your Salesforce Einstein chatbot.\n\n__Did you read the [Botium in a Nutshell](https://medium.com/@floriantreml/botium-in-a-nutshell-part-1-overview-f8d0ceaf8fb4) articles? Be warned, without prior knowledge of Botium you won't be able to properly use this library!__\n\n## How it works\nBotium connects to your Einstein chatbot using the [Salesforce Live Agent REST API](https://developer.salesforce.com/docs/atlas.en-us.live_agent_rest.meta/live_agent_rest/live_agent_rest_understanding_resources.htm). \n\nIt can be used as any other Botium connector with all Botium Stack components:\n* [Botium CLI](https://github.com/codeforequity-at/botium-cli/)\n* [Botium Bindings](https://github.com/codeforequity-at/botium-bindings/)\n* [Botium Box](https://www.botium.at)\n\n## Requirements\n* **Node.js and NPM**\n* a **Einstein bot**\n* a **project directory** on your workstation to hold test cases and Botium configuration\n\n## Install Botium and Einstein Connector\n\nWhen using __Botium CLI__:\n\n```\n\u003e npm install -g botium-cli\n\u003e npm install -g botium-connector-einsteinbot\n\u003e botium-cli init\n\u003e botium-cli run\n```\n\nWhen using __Botium Bindings__:\n\n```\n\u003e npm install -g botium-bindings\n\u003e npm install -g botium-connector-einsteinbot\n\u003e botium-bindings init mocha\n\u003e npm install \u0026\u0026 npm run mocha\n```\n\nWhen using __Botium Box__:\n\n_Already integrated into Botium Box, no setup required_\n\n## Connecting Einstein chatbot to Botium\n\nYou have to collect some information from your Salesforce instance - see capabilities description below.\n\nCreate a botium.json in your project directory, filling in the required information:\n\n```\n{\n  \"botium\": {\n    \"Capabilities\": {\n      \"PROJECTNAME\": \"\u003cwhatever\u003e\",\n      \"CONTAINERMODE\": \"einsteinbot\",\n      \"EINSTEINBOT_ENDPOINT\": \"xxx\",\n      \"EINSTEINBOT_ORGANIZATION_ID\": \"xxx\",\n      \"EINSTEINBOT_DEPLOYMENT_ID\": \"xxx\",\n      \"EINSTEINBOT_CHATBUTTON_ID\": \"xxx\"\n    }\n  }\n}\n```\n\nTo check the configuration, run the emulator (Botium CLI required) to bring up a chat interface in your terminal window:\n\n```\n\u003e botium-cli emulator\n```\n\nBotium setup is ready, you can begin to write your [BotiumScript](https://github.com/codeforequity-at/botium-core/wiki/Botium-Scripting) files.\n\n### Cleanup Salesforce Live Chat Transcrips\n\nThe 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:\n\n* Open the [Salesforce Workbench](https://workbench.developerforce.com/) and login\n* Use the Queries / SOQL option to download the Salesforce ids of LiveChatTranscript (_SELECT Id FROM LiveChatTranscript_), LiveChatTranscriptEvent (_SELECT Id FROM LiveChatTranscriptEvent_) and LiveChatVisitor (_SELECT Id FROM LiveChatVisitor_) as _Bulk CSV_\n* Use the Queries / Delete option to upload the CSV files and delete **ALL THE RECORDS FROM THE BEFORE MENTIONED TABLES** (be very careful)\n* In Salesforce, use the _Recycle Bin_ to finally delete those records\n\n## Supported Capabilities\n\nSet the capability __CONTAINERMODE__ to __einsteinbot__ to activate this connector.\n\n### EINSTEINBOT_ENDPOINT\nChat API Endpoint\n\nFind it in Salesforce: Service Setup | Channels | Chat | Chat-Settings\n\n### EINSTEINBOT_ORGANIZATION_ID\nOrganization Id\n\nFind it in Salesforce: Setup | Company Settings | Company information\n\n### EINSTEINBOT_DEPLOYMENT_ID\nDeployment Id\n\nFind it in Salesforce: Service Setup | Channels | Chat | Deployments, click on deployment and get it from the page url (address=%2F\u003cxxxxxx\u003e)\n\n### EINSTEINBOT_CHATBUTTON_ID\nChatbot Button Id\n\nFind it in Salesforce: Service Setup | Channels | Chat | Chat Buttons, click on button and get it from the page url (address=%2F\u003cxxxxxx\u003e)\n\n### EINSTEINBOT_VISITORNAME\nVisitor name (optional)\n\nVisitor name to be used for the Botium conversations \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodeforequity-at%2Fbotium-connector-einsteinbot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodeforequity-at%2Fbotium-connector-einsteinbot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodeforequity-at%2Fbotium-connector-einsteinbot/lists"}