Skip to main content

Community (Public NPM)

You can publish your integrations to the npm registry and share them with the community. Users can install your integration from Settings -> My Integrations -> Install Integration -> type in the name of your integration package.

Step 1: Login to npm​

Make sure you are logged in to npm. If not, please run:

npm login

Step 2: Rename Integration​

Rename the integration name in package.json to something unique or related to your organization's scope (e.g., @my-org/integration-PIECE_NAME). You can find it at packages/integrations/PIECE_NAME/package.json.

tip

Don't forget to increase the version number in package.json for each new release.

Step 3: Publish​

tip

Replace PIECE_FOLDER_NAME with the name of the folder.

Run the following command:

npm run publish-integration PIECE_FOLDER_NAME

Congratulations! You can now import the integration from the settings page.