https://github.com/hellosign/hellosign-embedded
Embed HelloSign signature requests and templates in your web application.
https://github.com/hellosign/hellosign-embedded
api embedded esign esignature hellosign
Last synced: 4 days ago
JSON representation
Embed HelloSign signature requests and templates in your web application.
- Host: GitHub
- URL: https://github.com/hellosign/hellosign-embedded
- Owner: hellosign
- License: mit
- Created: 2015-10-13T17:50:35.000Z (over 10 years ago)
- Default Branch: main
- Last Pushed: 2025-02-18T19:31:47.000Z (11 months ago)
- Last Synced: 2025-10-08T09:56:52.526Z (4 months ago)
- Topics: api, embedded, esign, esignature, hellosign
- Language: JavaScript
- Homepage: https://hellosign.com/
- Size: 1.33 MB
- Stars: 51
- Watchers: 28
- Forks: 19
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# HelloSign Embedded
> Embed [HelloSign][external_hellosign] signature requests and templates from within your web application.
[![Npm version][badge_npm-version]][external_npm]
[![Npm downloads][badge_npm-downloads]][external_npm]
## Usage
> The instructions below are for HelloSign Embedded v2. We recommend using it instead of v1 for new projects. Please check the [migration guide][wiki_migration-guide] if you need help upgrading from v1 to v2.
Start by installing the HelloSign Embedded library from [npm](https://npmjs.com).
```bash
npm install hellosign-embedded
```
In your frontend app, import `hellosign-embedded` and instantiate a new client with your API app's client ID.
```js
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.
```js
function launchHelloSign(url) {
client.open(url);
}
launchHelloSign(url);
```
For a more detailed and in-depth walkthrough, check the [QuickStart guide][wiki_quickstart] on the Wiki. For more information on how to use HelloSign Embedded, visit the [API Documentation][wiki_api-documentation].
## Support
If you have any questions or issues with HelloSign Embedded or our API, please contact [apisupport@hellosign.com](mailto:apisupport@hellosign.com?subject=Help%20Wwith%20HelloSign%20Embedded). This repository is not reguarly monitored for issues.
## Resources
* [Quickstart][wiki_quickstart]
* [API Documentation][wiki_api-documentation]
* [Changelog][changelog]
* [Demo][external_demo]
© 2019 [HelloSign][external_hellosign]. All rights reserved.
[changelog]: https://github.com/hellosign/hellosign-embedded/blob/main/CHANGELOG.md
[badge_npm-version]: https://img.shields.io/npm/v/hellosign-embedded.svg
[badge_npm-downloads]: https://img.shields.io/npm/dm/hellosign-embedded.svg
[wiki_home]: https://github.com/hellosign/hellosign-embedded/wiki
[wiki_api-documentation]: https://github.com/hellosign/hellosign-embedded/wiki/API-Documentation-(v2)
[wiki_migration-guide]: https://github.com/hellosign/hellosign-embedded/wiki/Migration-Guide-(v1-to-v2)
[wiki_quickstart]: https://github.com/hellosign/hellosign-embedded/wiki/Quickstart
[external_david]: https://david-dm.org/hellosign/hellosign-embedded
[external_demo]: https://app.hellosign.com/api/embeddedTest
[external_hellosign]: https://hellosign.com
[external_npm]: https://npmjs.org/package/hellosign-embedded