helloworks-sdk

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

1.3.0
latest
Source
npm

Version published: 4 years ago

Maintainers: 4

Created: 6 years ago

Source

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

Keywords

FAQs

What is helloworks-sdk?

Is helloworks-sdk well maintained?

Package last updated on 08 Jan 2021

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install