{"id":15524389,"url":"https://github.com/codeforequity-at/botium-connector-liveperson","last_synced_at":"2025-03-28T20:48:30.124Z","repository":{"id":37104874,"uuid":"408434395","full_name":"codeforequity-at/botium-connector-liveperson","owner":"codeforequity-at","description":"Botium Connector for Liveperson","archived":false,"fork":false,"pushed_at":"2024-12-11T19:14:57.000Z","size":38,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-02-03T06:35:27.599Z","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":"2021-09-20T12:29:55.000Z","updated_at":"2024-06-03T14:15:24.000Z","dependencies_parsed_at":"2023-12-11T13:01:12.999Z","dependency_job_id":"85c41ab8-cf6f-4ac5-a20a-993ba09f3941","html_url":"https://github.com/codeforequity-at/botium-connector-liveperson","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-liveperson","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-liveperson/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-liveperson/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-liveperson/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codeforequity-at","download_url":"https://codeload.github.com/codeforequity-at/botium-connector-liveperson/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246100488,"owners_count":20723469,"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:08.435Z","updated_at":"2025-03-28T20:48:30.098Z","avatar_url":"https://github.com/codeforequity-at.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Botium Connector for Live Person\n\n[![NPM](https://nodei.co/npm/botium-connector-liveperson.png?downloads=true\u0026downloadRank=true\u0026stars=true)](https://nodei.co/npm/botium-connector-liveperson/)\n\n[![Codeship Status for codeforequity-at/botium-connector-liveperson](https://app.codeship.com/projects/ac5ab3a0-d0f5-0138-cac3-16239a5027f5/status?branch=master)](https://app.codeship.com/projects/408148)\n[![npm version](https://badge.fury.io/js/botium-connector-liveperson.svg)](https://badge.fury.io/js/botium-connector-liveperson)\n[![license](https://img.shields.io/github/license/mashape/apistatus.svg)]()\n\n\nThis is a [Botium](https://github.com/codeforequity-at/botium-core) connector for testing your [Live Person chatbot](https://www.liveperson.com/).\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 the API of your Live person chatbot.\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 **Live Person bot**\n* a **project directory** on your workstation to hold test cases and Botium configuration\n\n## Install Botium and Live Person Connector\n\nWhen using __Botium CLI__:\n\n```\n\u003e npm install -g botium-cli\n\u003e npm install -g botium-connector-liveperson\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-liveperson\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 Live Person chatbot to Botium\n\nFirst of all you have to login and install a new application on Live Person [Connector App Hub](https://connector-api.dev.liveperson.net/). \nDuring the installation please set up the webhook endpoint field according to your server endpoint (from localhost you can use [ngrok](https://ngrok.com/), see later)\n\nAfter the installation you will see a new row in the application installations list. \nCreate a `botium.json` file and copy the following values in:\nYou have to copy the id value from the `Application Name \u0026 id` column into the `LIVEPERSON_CLIENT_ID`.\nYou have to copy the `secret` column value into the \n\n```\n{\n  \"botium\": {\n    \"Capabilities\": {\n      \"PROJECTNAME\": \"\u003cwhatever\u003e\",\n      \"CONTAINERMODE\": \"liveperson\",\n      \"LIVEPERSON_CLIENT_ID\": \"018908a5-aa8f-4f2a-bae4-1efe1f092e27\",\n      \"LIVEPERSON_CLIENT_SECRET\": \"s8r6ttaar0m5ev2qaqhkbs9m5\",\n      \"LIVEPERSON_ACCOUNT_ID\": \"72165163\"\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://botium.atlassian.net/wiki/spaces/BOTIUM/pages/491664/Botium+Scripting+-+BotiumScript) files.\n\n## How to start samples\n\nThere is a small demo in [samples](./samples) with Botium Bindings. \nBy changing the corresponding capabilities you can use it with the default Live Person chatbot.\n\n### Live Person chatbot sample\n\n* Install the dependencies and botium-core as peerDependency:\n    ```\n    \u003e npm install \u0026\u0026 npm install --no-save botium-core\n    ```\n* Navigate into the _samples/real_ directory\n    * Install the dependencies\n        ```\n        \u003e cd ./samples/real\n        \u003e npm install\n        ```\n    * Adapt botium.json in the sample directory:\n        * Change `LIVEPERSON_CLIENT_ID` with your installed application id\n        * Change `LIVEPERSON_CLIENT_SECRET` with your installed application secret\n        * Change `LIVEPERSON_ACCOUNT_ID` with your accound id\n\n    * Start `inbound-proxy` (it will listen on `http://127.0.0.1:45100/`):\n         ```\n         \u003e npm run inbound\n         ```\n    * In your installed application you need to set `Webhook endpoint` according to the previous step set up inbound-proxy url.\n      (To make this localhost url public you can use e.g. [ngrok](https://ngrok.com/))\n    * Finally run the test\n        ```\n        \u003e  npm test\n        ```\n\n## Supported Capabilities\n\nSet the capability __CONTAINERMODE__ to __liveperson__ to activate this connector.\n\n### LIVEPERSON_CLIENT_ID*\nLive Person installed application id\n\n### LIVEPERSON_CLIENT_SECRET*\nLive Person installed application secret\n\n### LIVEPERSON_ACCOUNT_ID*\nYour account id\n\n### LIVEPERSON_CAMPAIGN_ID\nFilling `campaignId` and `engagementId` you can route your conversation to a specific bot.\n\n### LIVEPERSON_ENGAGEMENT_ID\nFilling `campaignId` and `engagementId` you can route your conversation to a specific bot.\n\n### LIVEPERSON_CLIENT_PROPERTIES\nYou can define a client properties object, which is sent in the header of the request at open conversion.\nE.g.:\n```\n{\n  \"type\": \"ClientProperties\",\n  \"features\": [\n    \"AUTO_MESSAGES\"\n  ]\n}\n```\n\n### LIVEPERSON_USER_PROFILE\nYou can define a user profile object.\nE.g.:\n```\n{\n  \"firstName\": \"Botium\",\n  \"lastName\": \"\",\n  \"role\": \"consumer\",\n  \"description\": \"\"\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodeforequity-at%2Fbotium-connector-liveperson","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodeforequity-at%2Fbotium-connector-liveperson","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodeforequity-at%2Fbotium-connector-liveperson/lists"}