LiveChat Developer SDK

This project is an SDK for creating applications in the Text Developer Program.

📦 Installation

Use the npm or yarn package managers to install the developer-sdk package in your project.

npm install -g @livechat/developer-sdk
# or
yarn global add @livechat/developer-sdk

The NPM package is distributed both as a CommonJS and ES6 module. It should be used together with a module bundler, such as Webpack or Rollup.

We also distribute a UMD build of the package, which can be used directly in the browser.

<script src="https://unpkg.com/@livechat/developer-sdk@latest/dist/developer-sdk.umd.min.js"></script>

🚀 Usage

Application config

Developer application bootstrapped from our template can use autogenerated developer application config:

import appConfig from './livechat.config.json';

Developer application config can be also created manually:

const appConfig: DeveloperAppConfig = {
  appId: 'xxxxx',
  auth: {
    clientId: 'yyyy',
  },
};

Application instance

const app = await DeveloperApp.init(appConfig);

⚙️ Getting started

app.utils.reporting.notifyUserActivity();
app.utils.reporting.sendError(ErrorType.5xx);
app.utils.reporting.sendEvent(...);

📃 License

The code and documentation in this project are released under the MIT License.

🧑‍💻 Text Platform: who are we?

Behind Text, there’s a team of passionate people building online customer service software with online chat, help desk software, chatbot, and web analytics capabilities.

With a suite of five products (LiveChat, ChatBot, HelpDesk, KnowledgeBase, and OpenWidget) and their powerful APIs, we power customer communication for 36,000 companies in 150 countries.

The Platform is a range of products and services that can be used to build a variety of communication tools for businesses. Our Developer Program and Marketplace create an open ecosystem for developers, partners, and customers. With our advanced APIs and comprehensive documentation, you can shape the future of communication with us — starting today.

Join our Discord to learn, get inspired, and meet other developers!