{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Custom Hypersync app package.json reference","description":"Hyperproof developer resources for custom integrations.","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"custom-hypersync-app-packagejson-reference","__idx":0},"children":["Custom Hypersync app package.json reference"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Every custom Hypersync app must have a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["package.json"]}," file that contains certain properties. Hyperproof uses these property values to properly identify and display your custom Hypersync app in the Hyperproof user interface."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["package.json"]}," file for a custom Hypersync app must contain the values shown below:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n    \"name\": \"custom-hypersync-app\",\n    \"version\": \"1.0.0\",\n    \"app_hyperproof\": {\n        \"name\": \"My Custom Hypersync App\",\n        \"appType\": \"hypersync\",\n        \"authType\": \"custom\",\n        \"category\": \"Identity Services\",\n        \"descriptionCapabilities\": \"This integration extracts user and group information from The Target Service.\",\n        \"debug\": true,\n        \"staticIp\": false,\n        \"schemaCategories\": [\n          \"uarApplication\", \"uarDirectory\"\n        ]\n    },\n    ...\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note"]},": The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["schemaCategories"]}," array is optional and only required for Hypersyncs that need to utilize the Access Review module."]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note"]},": When attempting to upgrade existing Hypersyncs to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["schemaCategories"]}," for Access Review proof types, you must first delete the existing Hypersync using the CLI command:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"hp customapps delete\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This ensures that the new ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["schemaCategories"]}," definition is added to your Hypersync."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"name","__idx":1},"children":["name"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}," property is a standard ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["package.json"]}," attribute. All custom Hypersync apps must include this property. The package name is used as an identifier by the Hyperproof CLI. Keep this in mind when choosing the package name."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For more information on the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}," attribute, see the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#name"},"children":["official npm docs"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"version","__idx":2},"children":["version"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["version"]}," property is a standard ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["package.json"]}," attribute. This value is stored by Hyperproof when the custom Hypersync app is imported, and it's shown in the console when running commands such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["hp customapps list"]},". It's strongly recommended to follow ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://semver.org/"},"children":["semver versioning"]}," when making changes to custom Hypersync apps."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For more information on the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["version"]}," attribute, see the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version"},"children":["official npm docs"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"app_hyperproof","__idx":3},"children":["app_hyperproof"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["app_hyperproof"]}," value in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["package.json"]}," is an object that contains values that Hyperproof uses to properly expose and run your custom Hypersync app. The object must contain the values in the table below:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"style":{"width":"175px"}},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Attribute"]}]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The name of your application as shown in the Hyperproof UI."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["appType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The type of custom app. Must be set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["hypersync"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["authType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The type of authentication/authorization used by your app. Acceptable values are ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["custom"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["oauth"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["category"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The category of your custom Hypersync app as shown in the Hypersync wizard. This value is also shown in Hyperproof in ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Settings > Connected accounts"]},". Can be any string value, but it's recommended to reuse an existing category, if applicable."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["descriptionCapabilities"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Description shown to the user when inspecting a connection in Hyperproof in ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Settings > Connected accounts"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["debug"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}," to include debug information, e.g. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Logger.debug output"]},", in the logs."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["staticlp"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean value (true or false) that indicates whether or not a static IP address is required. If your target service is on premise or lives behind a firewall setting, setting this to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}," allows you to open a port for your custom Hypersync app to talk to the target service. Default value is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["schemaCategories"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional array value containing one or both of the Access Review categories (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["uarApplication"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["uarDirectory"]},"). This is for use with Access Review Hypersyncs."]}]}]}]}]}]},"headings":[{"value":"Custom Hypersync app package.json reference","id":"custom-hypersync-app-packagejson-reference","depth":1},{"value":"name","id":"name","depth":2},{"value":"version","id":"version","depth":2},{"value":"app_hyperproof","id":"app_hyperproof","depth":2}],"frontmatter":{"seo":{"title":"Custom Hypersync app package.json reference"}},"lastModified":"2026-02-26T22:35:50.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/hypersync-sdk/doc/030-package-json-reference","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}