NOTE: This project has been archived. If anyone has any interest in using or continuing development, please contact the maintainers at mailto:sdk@greenkeytech.com
Voice-enable your front-end apps with instant intercoms
The GreenKey Intercom SDK is the easiest way to embed instant intercom communication into your application. With minimal setup, your app can have push-to-talk technology, providing your users a fast, convenient way to collaborate with colleagues in your community.
This SDK provides front-end libraries and components which leverage the GreenKey telephony backend.
The GreenKey Intercom SDK is hosted by the Voice Program of the Fintech Open Source Foundation (FINOS). If you are a company interested in the evolution of open standards, interoperability, and innovation in the financial services sector, please consider joining FINOS.
- Node.js 8.11.3 (LTS) or higher
- A Node package manager (i.e. npm or yarn)
- An API key: obtain a GreenKey API key by emailing your request to mailto:sdk@greenkeytech.com
npm init or yarn init
In the package.json file for your project, list the SDK as a dependency, and then point it to the path of the SDK location on your computer, like so:
"dependencies": {
"greenkey-intercom-sdk": "file:../sdk"
},Then, from the top level directory of your project, run a command to install your dependencies.
npm install or yarn
After that, the greenkey-intercom-sdk should be added to your project's node_modules/ folder.
Before the SDK will work, you will need to point it toward a URL endpoint that has been approved for your use by GreenKey. You will receive this with your API key. This endpoint will be used as the main argument for instantiating the GreenKey class in the SDK.
See the example projects for the constants to set accordingly.
You are now ready to begin using the GreenKey Intercom SDK!
Once installed, you can start building by exploring the SDK documentation, examples, and tutorials.
You may generate the documentation by following these easy instructions.
For a tutorial on getting started, check out "Creating An Intercom" in the docs. Feel free to check out the rest of the docs for an explanation of the various functions contained therein.
Other great resources are the sdk examples which use the SDK in simple, functional web pages with intercoms.
Please make sure you read and observe our Code of Conduct.
- Fork it
- Create your feature branch (
git checkout -b feature/fooBar) - Commit your changes (
git commit -am 'Add some fooBar') - Push to the branch (
git push origin feature/fooBar) - Create a new Pull Request
We use SemVer for versioning. For the versions available, see the tags on this repository.
Original authors:
For all others who have aided this project, please see the list of contributors.
The code in this repository is distributed under the Apache License, Version 2.0.
Copyright (c) 2019 Greenkey