Updating to the latest version

To update your SDK to the latest version, run the following commands in your app or codebase referencing the SDK:
npm install @useparagon/connect@latest

Release Notes

v2.1.1
Improvements:
  • Adds support for the user-configured-oauth authentication type for the Headless Connect Portal.
Fixes:
  • Fixes types for installIntegration to include selectedCredentialId in available options.
  • Fixes connection issues for the Headless Connect Portal for certain integrations that have a PreOptionsStage, like Zendesk.
v2.1.0
Improvements:
  • Adds support for oauthTimeout option to the installFlow.start method of the Headless Connect Portal, to specify the number of milliseconds to wait for the OAuth prompt to complete.
  • Adds OAuthBlockedError and OAuthTimeoutError as possible error types for installFlow.start to detect when the OAuth prompt is blocked by the browser or takes longer than expected.
v2.0.10
Improvements:
  • Adds a centralized onError callback for the installFlow.start method of the Headless Connect Portal.
Fixes:
  • Fixes types for paragon.connect to include definitions for Custom Dropdowns.
  • Fixes an issue where Multi-Account Authorization could not be used with the Headless Connect Portal.
v2.0.9
Fixes:
  • Fixes an issue where Multi-Config could not be used correctly when sending App Events with the SDK.
v2.0.8
Improvements:
  • Adds support for Multi-Account Authorization for File Pickers.
v2.0.7

New: Field Mapping for all integrations

You can now define custom Field Mapping inputs for any integration using the SDK.Learn more about how to use the new SDK options in the Field Mapping documentation.
v2.0.6
Improvements:
  • Updates paragon.request method to use the new URL changes introduced in the 2025-07 API release.
Fixes:
  • Fixes an issue where the Headless Connect Portal might not progress to the post-OAuth stage when the OAuth prompt is completed.
v2.0.5
Improvements:
  • Adds support for Box File Picker.
Fixes:
  • Fixes an issue where showPortalAfterInstall option in installIntegration did not correctly prompt the Connect Portal after install.
  • Fixes an issue where the Headless Connect Portal (using installIntegration) intermittently did not show post-OAuth options (such as SharePoint site selection) after the OAuth prompt was completed.
v2.0.4
Improvements:
  • Exposes new CredentialStatus and IntegrationMetadata types from the SDK.
v2.0.3
Improvements:
  • Removes call to /sdk/projects to improve performance of SDK authentication.
v2.0.2
Improvements:
  • Updates return types of Headless Connect Portal function getDataSourceOptions to show all available fields for input sources.
v2.0.1
Improvements:
  • Updates getFieldOptions function to make parameters field optional.
v2.0.0

New: Headless Connect Portal improvements

We have made major improvements to the Headless Connect Portal which now support all functions of the hosted Connect Portal, including User Settings, Field Mappings, and Workflows.See our updated documentation and example implementation here.

Breaking changes

  • There are no breaking changes in this release. If you are using the Headless Connect Portal in v1.x of the SDK, all existing functionality with installIntegration() will be preserved.
  • To opt-in to improvements to the Headless Connect Portal that can utilize more of your own UI components, see our migration guide below.

Migrating from v1 of the Headless Connect Portal

If you are currently using the Headless Connect Portal in v1.x of the SDK, you can update your implementation to take advantage of the new functions introduced in this release.
  1. Call .setHeadless in your implementation to opt in to the new version of the Headless Connect Portal:
    paragon.setHeadless(true);
    
  2. Implement all stages of the authentication flow described in the Headless Connect Portal docs. In v1.x of the SDK, the following stages were handled by the headful Connect Portal appearing and should now be implemented by your own components:
    • Account Type selection (e.g. Salesforce Production vs. Salesforce Sandbox) — AccountTypeStage
    • Pre-OAuth / API Key inputs (e.g. Stripe API Key input, Shopify Store URL) — PreOptionsStage
    • Post-OAuth inputs (e.g. Atlassian site, SharePoint site selection) — PostOptionsStage
    • To implement the above stages, replace paragon.installIntegration with paragon.installFlow.start (this function will guide you through the above install stages):
    Migrating to installFlow
    paragon.installIntegration("salesforce"); 
    paragon.installFlow.start("salesforce", { 
        // Handle all stages of the install flow
    });