HelloSign Embedded

Embed HelloSign signature requests and templates from within your web application.

Usage

The instructions below are for HelloSign Embedded v2. We recommend using it instead of v1 for new projects. Please check the migration guide if you need help upgrading from v1 to v2.

Start by installing the HelloSign Embedded library from npm.

npm install hellosign-embedded

In your frontend app, import hellosign-embedded and instantiate a new client with your API app's client ID.

import HelloSign from 'hellosign-embedded';

// Create the HelloSign Embedded instance.
// Only do this once!
const client = new HelloSign({
  clientId: 'Your client ID'
});

When you're ready to launch HelloSign Embedded, simply call open() on the client with your signature request's signing URL.

function launchHelloSign(url) {
  client.open(url);
}

launchHelloSign(url);

For a more detailed and in-depth walkthrough, check the QuickStart guide on the Wiki. For more information on how to use HelloSign Embedded, visit the API Documentation.

Support

If you have any questions or issues with HelloSign Embedded or our API, please contact apisupport@hellosign.com. This repository is not reguarly monitored for issues.

Resources

• Quickstart
• API Documentation
• Changelog
• Demo

© 2019 HelloSign. All rights reserved.

Changelog

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

2.12.0 (2023-12-27)

Features

• github actions replaces travis for ci/cd operations. Sign REF: SPDE-130

2.11.1 (2023-07-18)

2.11.0 (2023-07-18)

Features

• Drop support for es-MX locale (4c95cf6)

Bug Fixes

• Config option to allow native zoom overrides (#180) (34d02d8)

2.10.0 (2021-05-18)

Features

• Update node-sass and sass-loader (0234daf)

Bug Fixes

• Do not use self-closing tags in HTML markup (9520b39)

2.9.0 (2020-09-01)

Features

• Avoid defaulting to English if locale is not set (1baea0c)

2.8.0 (2020-06-29)

Features

• Update locale-related tests (c9ce102)
• Fix comment for en-GB locale (fc807dd)
• More lax valdation for locale (2d30ba4)
• Use hyphenated locale codes by default (e5e467d)
• Add default z-index to modal (dcd0166)
• Add support for more languages (c8e3abf)

2.7.2 (2020-03-31)

Bug Fixes

• DEV-8771: Fix click handler (5062270), closes #128
• DEV-8775: Makes UMD importable in Node (5c71512), closes #129 #107

2.7.1 (2020-02-21)

2.7.0 (2020-02-21)

Features

• Remove onunload handler before redirecting (08c047c), closes #138

2.6.0 (2019-10-23)

Features

• DEV-7285: Add Czech locale support (#132) (6498755)

2.5.0 (2019-05-30)

Features

• DEV-5970: Add Italian locale support (44d6e25)

2.4.0 (2019-05-10)

Bug Fixes

• DEV-5984: Allow close after user has been redirected (0fbf3e3)
• DEV-5992: Update url-polyfill to latest to fix issue with IE11 (72e44b6)

Features

• DEV-5737: Add Japanese locale support (a7015fd)

2.3.0 (2019-02-27)

Bug Fixes

• DEV-5419: Close button alignment on IE11 (844b8a3), closes #105

Features

• Use mobile layout for mobile devices in landscape orientation (7f736a8)

2.2.0 (2019-01-25)

Bug Fixes

• Transform modules via Babel to CommonJS instead of UMD (48d560a)

Features

• add testMode as an alias to skipDomainVerification (6d5178b)

2.1.3 (2019-01-24)

Bug Fixes

• Transpile node modules (4f19db5), closes #99

2.1.2 (2019-01-22)

Bug Fixes

• Change close button hover color to something more neutral (8fd0386)
• Only export development version when importing via module (c6a63cf), closes #93 #95

2.1.1 (2018-11-20)

Bug Fixes

• Fix URL polyfill (0cde022)

2.1.0 (2018-11-19)

Features

• DEV-4831: Adds close confirmation dialog message when beforeunload fires. (4ac9cca)

2.0.1 (2018-10-17)

• Add close button to Embedded signing workflow (176cfb8)
• Allow "Save" to be used as final button text (ab9456d)
• Automatically apply UX version 2 to all requests (8542a37)
• README Changelog link (1749ed2)

2.0.0 (2018-10-11)

• DEV-4322: HelloSign Embedded v2 (#80) (2702594), closes #80 #27 #31 #36 #40 #47 #57 #75

BREAKING CHANGES

• HelloSign is now a class, not a singleton.
• HelloSign.VERSION is now HelloSign.version
• The url option is now the first argument of open()
• open() options are now defined as the second argument
• userCulture option is now named locale
• healthCheckoutTimeoutMs option is now named timeout
• init() has been deprecated
• messageListener option has been removed
• uxVersion option has been removed
• height option has been removed
• HelloSign.CULTURES is now HelloSign.locales
• requester option is now named requestingEmail