0.0.4 • Published 1 year ago

@mrmenezesdev/chatwoot-client v0.0.4

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

@mrmenezesdev/chatwoot-client

A node.js client for Chatwoot APIs

Note: This is a work in progress. Interface can change before a stable release.

How to use

  1. Install the library
yarn add @mrmenezesdev/chatwoot-client

or

npm install --save @mrmenezesdev/chatwoot-client
  1. Create a Chatwoot Client by providing the host URL and API Access Token
import { ChatwootClient } from '@mrmenezesdev/chatwoot-client';

const config = {
  host: 'https://app.chatwoot.com',
  apiAccessToken: 'your-access-token',
};
const Chatwoot = new ChatwootClient({ config });

Supported config params are shown below.

KeyDefault ValueRequiredDescription
hosthttps://app.chatwoot.comFalseThe API Host URL, if you are using self-hosted Chatwoot, please change this value.
apiVersionapi/v1FalseThe version of the API, at the moment v1 is only available
apiAccessTokenTrueAPI access token to authenticate with the APIs. You can get the token from your Profile Settings
  1. Fire an API request
// ...

const getContacts = async (accountId) => {
  try {
    const { data } = await Chatwoot.contacts(accountId).get();
    console.log(data);
  } catch (error) {
    console.log(error);
  }
};

getContacts(1);