chipchat

ChipChat is the Web1on1 Node.js SDK that helps you manage Web1on1 resources and build chat bots. This library provides convenient access to the Web1on1 API from applications written in server-side JavaScript.

Build status

• master
• development

Installation

Install the package with:

  $ npm install chipchat --save

Usage

The package needs to be configured with your account's API token which is available in your Web1on1 Dashboard.

'use strict';

const ChipChat = require('chipchat');

// Create a new bot instance
const bot = new ChipChat({
    token: process.env.TOKEN
});

// Use any REST resource
bot.users.get(bot.auth.user).then((botUser) => {
    console.log(`Hello ${botUser.name}`);
});

// Listen to some resource events
bot.on('user.login', (payload) => {
    console.log(payload.activity.summary);
});
bot.on('organization.create', (payload) => {
    console.log('Organization created', payload.activity.summary);
});

// Accept all bot notifications
bot.on('notify', (message, conversation) => conversation.accept());

// Echo all messages as text
bot.on('message', (message, conversation) => conversation.say(`Echo: ${message.text}`));

// Subscribe using wildcards, respond to consumer
bot.on('message.*.contact.*', (message, conversation) => {
    conversation.say({ text: '👍', role: 'agent' });
});

// Listen to utterances
bot.onText(['hi', /hello/], (_, conversation) => conversation.reply('Hey there'));

// Start Express.js webhook server to start listening
bot.start();

See Quickstart to get started.

Features

• Full Web1on1 API v2 support
• Start conversations, ask questions and save important information in the context of the conversation.
• Organize your code in modules and middleware.
• Subscribe to events.
• http/https/express.js compatible webhooks
• Easy to extend

API Resources

All organization resources available through the API can be accessed by the SDK: users, channels, contacts, conversations, messages, organizations, orggroups, services, forms, workflows, kbases, kbitems, articles and files.

Each resource has the methods list,get,create,update and delete available to it. See REST API for more information.

Receiving Events

You can subscribe to any webhook callback events received by the webhook with the bot.on() method. See our webhooks guide for a full list of possible events.

See Events for more information on event subsriptions; read Ingesting Events to see how to process payloads from webhooks and other sources.

Sending Messages

A conversation context encapsulates all properties of a Web1on1 conversation, augmented with message sending methods.

See Conversations for more information.

Adding headers to each request

Sometimes you want to add some special header to each request. Here is how to do this.

const token = 'xxx';
new ChipChat({
    token,
    fetchExtensions: {
        beforeRequest: [async (options) => {
            options.headers = {
                 ...options.headers,
                 'extraheader': 'some value'
            }
         }]
    }
}

Extending ChipChat

Mixins

Mixins can be used to augment bot instances with your own functions.

Modules

Modules are simple functions that you can use to organize your code in different files and folders.

Middleware

Middlewares are functions that perform tasks before and after an operation (that call an API endpoint).

See Extending for more information.

Environment variables

See Internal API spec for a full list of possible constructor options. Some options can also be specified as environment variables. These are:

Testing

To run the test suite you have to create a .env file in your local Project dir and add the following keys:

then run: npm run test

Examples

Running thhe examples requires the TOKEN environment variable set as a valid API access token.

For examples see the examples folder. To try any of the examples, first set the TOKEN environment variable as a valid API access token:

export TOKEN=eyJhbGciOiJIUzI1NiIsInR5cCI6I...

Then, try any of the examples:

cd examples
node example.js

Documentation

See the Web1on1 Developer Hub for full platform documentation.