Papercups Node.js Library

The Papercups Node library provides convenient access to the Papercups API from applications written in server-side JavaScript.

Installation

Install the package with:

npm install @papercups-io/papercups --save
# or
yarn add @papercups-io/papercups

Usage

The package needs to be configured with an API key, which is available in the Papercups dashboard. Require the package with the key's value:

const papercups = require('@papercups-io/papercups')('PAPERCUPS_API_KEY');

papercups.messages
  .create({
    body: 'Hello world!',
    conversation_id: '...',
  })
  .then((message) => console.log(message))
  .catch((error) => console.error(error));

If you're self-hosting Papercups on a different server, you can specify the API host:

const papercups = require('@papercups-io/papercups')('PAPERCUPS_API_KEY', {
  host: 'https://papercups.mycompany.co',
});

Methods

Conversations

API reference: https://docs.papercups.io/api-endpoints#conversations

List conversations

await papercups.conversations.list(params);

Retrieve a conversation

await papercups.conversations.retrieve(id);

Create a conversation

await papercups.conversations.create(params);

Update a conversation

await papercups.conversations.update(id, updates);

Delete a conversation

await papercups.conversations.delete(id, updates);

Messages

API reference: https://docs.papercups.io/api-endpoints#messages

List messages

await papercups.messages.list(params);

Retrieve a message

await papercups.messages.retrieve(id);

Create a message

await papercups.messages.create(params);

Update a message

await papercups.messages.update(id, updates);

Delete a message

await papercups.messages.delete(id, updates);

Customers

API reference: https://docs.papercups.io/api-endpoints#customers

List customers

await papercups.customers.list(params);

Retrieve a customer

await papercups.customers.retrieve(id);

Create a customer

await papercups.customers.create(params);

Update a customer

await papercups.customers.update(id, updates);

Delete a customer

await papercups.customers.delete(id);

Users

API reference: https://docs.papercups.io/api-endpoints#users

Retrieve the current user

await papercups.users.me();

List the active users on your team

await papercups.users.list();

Retrieve a specific user on your team

await papercups.users.retrieve(id);