@symbolic/paragon-connect
v1.0.1
Published
paragon connect npm package
Downloads
7
Keywords
Readme
Paragon is an embedded integration platform that 100+ software companies rely on to rapidly accelerate development of native product integrations with 3rd party SaaS apps such as Salesforce, Slack, and QuickBooks. This allows their engineering teams to avoid the heavy costs and risks that come with building and maintaining dozens of their own integrations.
Usage
To install the Paragon SDK, run this command in your project to add it as a dependency:
npm install @useparagon/connect
This package is intended for usage in your frontend application to embed the Paragon connection experience. After importing the Paragon SDK, you can:
- Display the Connect Portal, a prebuilt UI component for your users to connect third-party app accounts
- Trigger Workflows, which are observable, durable jobs you define to sync integration data
- Send Connect API requests to access integration data in realtime from your app
- Render a custom integrations UI using the Headless Connect Portal
import { paragon } from '@useparagon/connect';
// Authenticate your user with the SDK
await paragon.authenticate(projectId, paragonUserToken);
// Launch the Connect Portal for Salesforce in your app
paragon.connect('salesforce');
Documentation
To start using the Paragon SDK, you will need to sign up and register for an account.
For details on getting started and a reference on all available SDK functions, please see our documentation.