API Reference

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

IntegryJS(config: SDKConfig)

SDK constructor method.

Name	Type	Required	Description
appKey	string	✅	App Key taken from the deployment page
hash	string	✅	Authentication hash generated server-side using app secret and user ID
userId	string	✅	User ID
deploymentId	string	✅	Deployment ID taken from the deployment page
userConfig	object	❌	User-provided config options
userConfig.availableFlowsLabel	string	❌	Give a custom name to the flows tab
userConfig.myFlowsLabel	string	❌	Give a custom name to the configured flows tab
userConfig.customElements	object	❌	Add your custom elements

IntegryJS.init(initConfig: IntegrySDKInitConfig)

Used to initiate rendering.

Name	Type	Required	Description
containerId	string	✅	Container ID in which to render
renderMode	"INLINE" | "MODAL" | "DETACHED"	✅	Specify which mode is used to render flow setup forms
templateContainerId	string	❌	Template container ID in which to render template form

IntegryJS.renderFlowSetupForm(setupConfig: FlowSetupConfig)

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

Name	Type	Required	Description
flowContainerId	string	✅	Container ID in which to render
flowId	string	❌	Flow ID for which to load the form. If not specified, will be taken from the URL `flowId` query parameter
integrationId	number	❌	Integration ID to open in edit mode

IntegryJS.printVersion()

Used to print the currently installed SDK version.

IntegryJS.destroy()

Used to cleanup and un-subscribe from subscribed events.