HelloWorks Node.js SDK

A Node.js SDK for easily creating and managing HelloWorks workflow instances.

Usage

Start by installing the HelloWorks SDK from npm.

npm install helloworks-sdk

In your backend app, require the helloworks-sdk library and instantiate a new client with your API key ID and secret.

const HelloWorks = require('helloworks-sdk');

const client = new HelloWorks({
  apiKeyId,
  apiKeySecret,
});

Use the client to easily make HelloWorks API requests without the overhead of handling responses and managing JWT authorization.

client.workflowInstances.getInstance({
  instanceId,
}).then((instanceObj) => {
  // ...
});

More examples and documentation can be found in the API Documentation Wiki page.

Note: It should go without saying that this library must never be used on the client side of your application. The HelloWorks Node.js SDK relies on sensitive API keys and by using it on the public-facing frontend codebase you will risk dangerously exposing your API key secret, which will make you vulnerable to impersonation attacks.

Resources

• API Documentation
• Changelog

© 2019 HelloSign. All rights reserved.

Change Log

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

1.3.0 (2021-01-08)

Features

• Added support for document delivery type (#13) (#15) (40b090b), closes #14

1.2.1 (2020-01-27)

1.2.0 (2020-01-24)

Bug Fixes

• Skip all tests for now (724b003)

Features

• Adds delegated_authentication and getAuthenticatedLinkForStep (a44cc1f)

1.1.1 (2020-01-24)

Bug Fixes

• Metadata (c032c41), closes #9

1.1.0 (2019-07-30)

Features

• Add support for metadata (f36907a), closes #5

1.0.3 (2019-04-10)

Bug Fixes

• Add *.test.js files to npmignore (f99d55c)

1.0.2 (2019-03-19)

1.0.1 (2019-03-13)

1.0.0 (2019-03-13)