# Share your connector
You can share your connector with other users in the Share console after you build your custom connector. You can share your connector through a private link or share it within the Community library with your source code open or closed.
Share console
# Released versions and shared versions
| Shared version | Released version |
|---|---|
| Your connector's shared version is the version which others receive when they install your connector for the first time. When you share a new version, everyone who installed your connector receives an option to update their connectors as well, including child connectors. | Your connector's released version is the version all your recipes use. When you release a new version of your connector, all recipes using this connector update to use this version immediately. |
# Share your connector for the first time
You must enable sharing in the Share tab if you plan to share a new custom connector. You must have at least one released version to enable sharing.
Click Tools > Connector SDK.
Select the custom connector you plan to share.
Click the Share version button to convert the Share tab into your new sharing console. The sharing console is where you control all sharing capabilities for your custom connector.
Empty state
# Share a connector with the community
There are two ways to share connectors in Workato. You can share your connector with the Workato community or share it with directly with other Workato accounts.
You can list your connector in the community as a quick and easy way to share your connector with all Workato users. Workato users are able to search for and install your connector for use in their own recipes through the Community library of custom connectors (opens new window).
BUILD INTEGRATIONS AS A COMMUNITY
You enable other Workato users to automate with your custom connector when you share with the community. This promotes and increases usage of the target application, while simultaneously expanding wall-to-wall automation use-cases for everyone.
Find out more about listing custom connectors and best practices.
# How to list your connector
You must provide information on which app your connector connects to as well as category tags and installation options. You should select the app that best describes your connector. It may take up to one business day to approve your custom connector before your listing is added to the Community library. We do this to ensure that all listings in the Community library are valid. Find out more about listing custom connectors and best practices.
Select the app your connector connects to when prompted. You can search for the name of the app and select from a list of apps that Workato has approved.
Select the app that your connector is built for
APPLICATION NAME NOT FOUND
Type in the name of the app in plain text if you can't find the app.
Provide category tags for you connector.
Select an option to determine if users can install your connector directly or not. The option to prevent direct installation allows you to direct people to a landing page of your choice where users can inquire more about your connector.
LOGO AND CATEGORY USAGE
You should only use a logo and provide categories that correspond to the app you plan to connect to. Workato may be required to disable your listing until your logos and categories are updated.
# Share connector with open source code
The open source option enables you to share all information for your custom connector, including triggers, actions, and the source code. This option also allows anyone to install your connector and to modify and distribute the source code after installation.
TEST ENVIRONMENT UPDATES FROM OPEN SOURCE TO CLOSED SOURCE
If you install an open-source connector into your Test environment, and your partner later updates the connector to closed-source and shares it, you can still update to the newest closed-source version in your Test environment.
Click Tools > Connector SDK.
Click the connector you plan to share and then click Set up connector sharing to open the configuration module.
Click Open source if you plan to make the source code of your custom connector publicly available.
Click Open source
Click Start sharing to see the sharing version information.
CHANGE FROM CLOSED TO OPEN SOURCE CODE
The latest version of your connector is automatically shared when you switch from closed source code to open source code.
Optional. Click the View version URL to review information specific to the connector version, including triggers, actions, and the source code.
Click View version
Open source version information
Click the Enable shareable link toggle to share your custom connector with others through a link.
Click Publish connector.
Publish your connector with open source code
An updated version notification is automatically sent to everyone that uses your custom connector. Update notifications are also pushed to all child connectors.
Open source updated version notification
# Share custom connectors with proprietary code
FEATURE AVAILABILITY
Closed code source sharing is only available to partners who have been given access to this feature.
You can share your custom connector without sharing your proprietary source code by selecting the closed source option. Proprietary code is controlled by partners and cannot be viewed, modified, shared, or distributed without permission from the owner after it is installed. The closed source option also enables you to define which Workato workspaces are allowed to install your connector. Ensure that you know the author of the connector before you install a closed-source custom connector. You take responsibility for the connector without access to the code source.
CLOSED CODE SOURCE FOR SAME DATA CENTERS ONLY
Closed code source sharing is only available within the same data center.
Click Tools > Connector SDK.
Click the connector you plan to share and then click Set up connector sharing to open the configuration module.
Click Closed source if you plan to keep the source code of your custom connector private.
Click Closed source
Click Start sharing to see the sharing version information.
CHANGE FROM OPEN TO CLOSED SOURCE CODE
The latest version of your connector is automatically shared when you switch from open source code to closed source code.
TEST ENVIRONMENT UPDATES FROM OPEN SOURCE TO CLOSED SOURCE
If your customers install an open-source connector into their Test environment, and you later update the connector to closed-source and share it, your customers can still update to the newest closed-source version in their Test environment.
Optional. Click the View version URL to review information specific to the connector version, including triggers and actions.
Closed source version information
Click the Enable shareable link toggle to share your custom connector with others through a link. Your source code is hidden and only specific workspaces can view and install your connector when you enable the shareable link. This options prevents those who receive the private link from sharing the connector with other users.
Click Manage access to define the workspaces allowed to view and install your custom connector.
Closed source managed access
Enter the email addresses of the workspaces that require access to your custom connector and select the Notify people checkbox if you plan to notify people that access to the connector has been granted.
Enter workspace emails
An updated version notification is automatically sent to workspaces that use your custom connector. Update notifications are also pushed to all child connectors.
Closed source updated version notification
Click Publish connector.
# Share your connector privately
You can share your connector through a private link. You can find this in the share tab of your SDK console. Users can access latest shared version of your connector with the shared link. The private link enables users to view and then install the shared version of your custom connector.
REFRESH SHARING TOKEN
You can revoke and generate your sharing token at any time. This provides more control over who has access to your custom connector.
Revoke sharing link
Generate sharing link
# Export packages with custom connectors
You can use the Recipe lifecycle management tool to export and import entire folders of recipes from a sandbox environment to a production environment in Workato. Recipes that you plan to export from one account and import into another often contain custom connectors that you have built or cloned. Workato helps to export custom connectors in the manifests when you export these recipes.
The latest released version and the attached version note of your custom connector used in recipes are included in the manifest export. Find out more about exporting here.
# Import a manifest with custom connectors
Workato first checks for an existing copy of the custom connector when you import a manifest. If no existing copy is found, a new custom connector is created with the latest released version as version 1. If an existing copy is found, a new latest version is created instead. In both cases, importing a manifest immediately releases the latest version of the custom connector for you because the recipes you are importing use that latest version. Find out more about importing here.
EXPLORE RECIPE DEPENDENCIES
Be sure to explore dependencies in the existing recipes in your production account when importing a manifest that overwrites a connector.
Last updated: 9/17/2024, 5:00:04 PM