Copper App SDK

Travis branch npm Test Coverage Maintainability

The javascript SDK provides client-side functionalities for adding embedded app to the Copper web client.

The Embedded app is an iframe embedded in the Copper web page. The display location of the iframe is configured in the embedded app's settings page.


Execute the following with your webpack/rollup/browserify etc.

yarn add copper-sdk
# or
npm install copper-sdk --save

Followed by:

import Copper from 'copper-sdk';
const sdk = Copper.init();

  .then(({ context }) => {
    // do something with the context

Use with CDN

copper-sdk is served with

<script type="text/javascript" src=""></script>
<script type="text/javascript">
var sdk = window.Copper.init();
  .then(function (data) {
    var type = data.type; // person,lead,...
    var context = data.context;
    // do something with the context

SDK Docs



We recommend Node 10.x.x LTS version (10.24.1 currently).

Confirm all packages have been installed before development. Yarn will be used for this particular project.


Developing SDK

## watch changes
yarn dev

## or run separately
yarn dev:es
yarn dev:commonjs

## build
yarn build

## test
yarn test
# or watch changes
yarn test:dev

## lint
yarn lint


How do I use my local SDK instead of the npm one?

Execute yarn link inside this repository, then navigate over to the other repository and execute yarn link copper-sdk.

An alternative way would be to execute npm link path/to/copper-sdk in the repository.

results matching ""

    No results matching ""