Skip to main content
Version: 3.0.14

API Reference

Reference docs for each of the full list of methods and functions available in the SDK.

IntegryJS(config: SDKConfig)#

SDK constructor method.

NameTypeRequiredDescription
appKeystringApp Key taken from the deployment page
hashstringAuthentication hash generated server-side using app secret and user ID
userIdstringUser ID
deploymentIdstringDeployment ID taken from the deployment page
userConfigobjectUser-provided config options
userConfig.availableFlowsLabelstringGive a custom name to the flows tab
userConfig.myFlowsLabelstringGive a custom name to the configured flows tab

IntegryJS.init(initConfig: IntegrySDKInitConfig)#

Used to initiate rendering.

NameTypeRequiredDescription
containerIdstringContainer ID in which to render
renderMode"INLINE" | "MODAL" | "DETACHED"Specify which mode is used to render flow setup forms
templateContainerIdstringTemplate container ID in which to render template form

IntegryJS.renderFlowSetupForm(setupConfig: FlowSetupConfig)#

Used to manually load the flow setup view in a specified container.

NameTypeRequiredDescription
flowContainerIdstringContainer ID in which to render
flowIdstringFlow ID for which to load the form. If not specified, will be taken from the URL `flowId` query parameter

IntegryJS.printVersion()#

Used to print the currently installed SDK version.

IntegryJS.destroy()#

Used to cleanup and un-subscribe from subscribed events.