Skip to content
Last updated

V6 Hypersync SDK migration guide

Version 3.x to version 6.0

The Hypersync SDK version 6.0 includes a number of new capabilities that require small changes to Hypersync apps that use versions 3.x or earlier.

Node version

Node JS version 22

As of May 1st, 2026, Hyperproof will only execute and support Hypersyncs that are built using Node version 22 and higher. All Hypersyncs must be updated to use the latest Hypersync SDK and Node JS 22.

After installing Node 22 and verifying the version used by your development environment, update your package.json file.

The engines section of your app's package.json file should be updated as follows:

  "engines": {
    "node": "^22.0.0"
  }

Package versions

The Hypersync SDK functionality is distributed via three Node packages:

Package
Version
Description
@hyperproof/hyperysnc-sdk6.0.0This is the core Hypersync SDK.
@hyperproof/hypersync-models6.0.0Supporting Hypersync models.
@hyperproof/integration-sdk6.0.0Common integration elements.

Previously each of these packages had various version numbers. For simplicity going forward, these packages were updated to have each of their version numbers in sync.

Dependencies

The dependencies section of your app's package.json file should be updated as follows:

  "dependencies": {
      "@hyperproof/hypersync-models": "^6.0.0",
      "@hyperproof/hypersync-sdk": "^6.0.0",
      "@hyperproof/integration-sdk": "^6.0.0",
    ...
  }

Dev Dependencies

The devdependencies section of your app's package.json file should be updated as follows:

  "devdependencies": {
    ...
      "@types/node": "22.10.10",
    ...
  }

Due to specific type dependencies, the types.node package needs to be updated to a specific version. Note there is no wildcard caret ^ in the version number.

If your code imported classes, types, interfaces, or enums from one of the other packages, those imports need to be updated after making this change.

Install the updated packages

Ensure the package dependencies are installed:

yarn install

Verify that the build is error free, correct any issues, and rebuild if necessary.

Build and deploy your Hypersync

Build your updated Hypersync:

yarn build

Make sure you are signed into your Hyperproof organization:

hp signin

Deploy your updated Hypersync:

hp customapps import -d .

Additional updates

IP address allowlist change (US Only)

New internal infrastructure for custom apps running version ^6.0.0 of the hypersync-sdk will cause the outgoing API calls to come from a new IP address. If you had previously added a Hyperproof address to your private server's allowlist, you may need to add additional addresses for your custom app to continue to function. See the "Integrations" IP Address for your instance of Hyperproof: https://docs.hyperproof.io/admin/en/get-to-know-hyperproof/hp-instances.html

OAuth callback change (US Only)

The current HP CLI will not give the correct callback URL. Be sure to follow these instructions to update your callback URL.

For the same reason as the IP address change, a new callback URL is required for all custom apps using oauth. Previous addresses are formatted according to the following template:

OAuth callback change (US Only)

For the same reason as the IP address change, a new callback URL is required for all custom apps using oauth. Previous addresses are formatted according to the following template:

https://api.us-west-1.fusebit.hyperproof.app/v1/run/sub-f63bb714ec30473e/org-{orgId}/{customAppId}/callback

The new URL template is:

https://hpip.hyperproof.app/v1/run/hpprod/org-{orgId}/{customAppId}/callback

It is a known issue that Hypersync SDK version 1.2.4 generates incomplete, only relative URLs. Use the following base URLs for your Hyperproof instance:

  • Hyperproof US: https://hpip.hyperproof.app/v1/run/hpprod
  • Hyperproof EU: https://hpip.hyperproof.eu/v1/run/hpprodeu

Update your oauth client's callback URL with this new value.

Finishing up

Update your oauth client's callback URL with this new value.

Test connecting to your updated Hypersync and run any existing Hypersyncs to ensure they are still working properly.