The Hypersync SDK makes it easy to create a custom Hypersync app that can be used to bring proof stored in an external service into Hyperproof.
Every Hypersync app is a Node.js module that is installed in your Hyperproof organization using the Hyperproof CLI. After installation, your custom Hypersync app becomes available to all users in your organization. They can use it to establish a connection with the external service and automatically bring proof into Hyperproof.
To use the Hypersync SDK you will need a Windows, Mac, or Linux computer with the following software packages installed:
- Node JS version 18 - Because each Hypersync is a Node.js module, you must have Node.js installed to build custom Hypersyncs.
- yarn package manager - This is the classic yarn package manager (version 1.22.19).
- Hyperproof CLI - This is needed to publish and manage your custom Hypersyncs.
It's highly recommended that you clone the public Hypersync SDK Samples GitHub repository.
- The Hypersync samples repository includes several complete example apps that demonstrate how to bring data from external services into Hyperproof. Using the Hypersync SDK, you can customize these samples to fit your integration needs. The hypersync-sdk-samples repository provides sample integrations for services such as MySQL, Zoho, and others. These example Hypersync apps are located in the
/appsdirectory. - The samples repository also includes a handful of templates to get you started building your own Hypersyncs from scatch. Templates are located in the
/templatesdirectory. See theREADME.mdfiles in each template directory information on using the templates.
For development purposes, it's highly recommended to have a separate "sandbox" organization in Hyperproof. This allows you to develop and test your custom Hypersync apps in isolation without affecting the users in your Hyperproof production environment. To create a "sandbox" organization, contact your Hyperproof Customer Service Manager (CSM).
After installing the prerequisites and selecting the Hyperproof organization you’ll use for development, you’re ready to install your first custom Hypersync app. Follow the steps in this section to install, test, and update one of the pre-built sample apps.