Integration Options
Last updated
Last updated
Each integration has an "Options" button (three dots in the right-hand corner). When you click it, you will see options for managing the integration.
Check out the details of each option below:
By clicking on the "View" integration option, you can check various information about the chosen item, as well as edit and configure it. The same view can be obtained by clicking directly on the integration.
In this area, there are two divisions: Information banner (name, image, etc) and Flows of this integration.
In addition to the name, images and description of the integration, in the top right corner you will find the following actions:
Copy: copies the integration's URL for sharing.
Duplicate: starts the sequence of steps for duplicating the integration;
Publish: activates the process of publishing the integration in the Marketplace;
Unpublish: deactivate the integration in the Marketplace;
Share: share a flow with a workspace you are part of;
Update: starts the integration update steps;
Delete: begins the series of procedures for deleting the integration.
At the bottom of the banner, you can see the following information:
Last execution: date and time of the integration's last execution (if any);
Versioning: version of the integration;
Attachments: allows you to add useful attachments to the integration;
Status: status of the integration (active or inactive).
In order to cover all the aspects and details of this area of the Integration view, we have provided information on each item on specific pages. Click on the desired option:
You can duplicate an integration. To do this, follow these steps:
Choose "Duplicate" from the Integration "Options" button.
A modal will appear to choose the space in which the integration will be duplicated. After choosing the space and check if you want to overwrite the modules already duplicated, simply click on "Duplicate".
Done! Your integration has been duplicated.
You can publish an integration in the Marketplace. This means that you can make an integration public in the Marketplace so that other people can use it.
To publish an integration, follow these steps:
Click on the "Options" button and then choose "Publish".
In addition to the name of the integration, the modal will display the fields Publication type, Description and Integration categories.
a) Publication type
The platform features the Major, Minor and Patch options, commonly known for updating systems and software.
Where:
Major: a significant update, such as important new features.
Minor: an intermediate update, such as bug fixes.
Patch: This is a minor update, such as correcting small errors.
Therefore, integration version numbering follows the format X.Y.Z, where:
X is the major version number;
Y is the minor version number;
Z is the patch number.
b) Description
After choosing the type of publication, the text field will become available so that you can describe the updates made to the integration.
c) Integration Categories
The Marketplace is divided into categories. When publishing an integration, you can choose one or more categories so that other users can find you more easily. For example: Database, Marketing, Payment, etc.
Finally, just click on "Publish" to make your integration part of the Marketplace.
Done! Your integration has been successfully published.
You can unpublish an integration in the Marketplace. This means that you can remove the publication if an integration you authored is in the Marketplace.
To unpublish an integration, follow these steps:
Click on the "Options" button and choose "Unpublish".
Then confirm your wish to remove the integration from the Marketplace by typing the name in the specific field on the screen and click "Unpublish".
Done! Your integration has been successfully unpublished.
You can share an integration for a workspace to which you belong. To do this, follow these steps:
Click on the "Options" button and then choose "Share".
Then choose one or more workspaces from the drop-down list.
Choose the "sharing type" (Major, Minor and Patch).
After choosing the sharing type, the screen shows a field to describe the updates (not mandatory).
Complete this step by clicking "Share".
The integration is not imported automatically.
Done! Your integration has been successfully shared.
To update an integration, follow these steps:
Click on the "Options" button and then choose "Update".
The modal will display the available versions of that integration, including the current version and the latest version (if any). To update, choose the version flagged as the latest version.
Once you've chosen the version, just confirm it with the "Update" button. Otherwise, press Cancel.
That's it! Your integration has been successfully updated.
To delete an integration, follow these steps:
Click on the "Options" button and then choose "Delete".
The confirmation screen for deleting the integration will appear. If you want to confirm, type the name of the integration in the specific field and then click "Delete".
It is not possible to reverse the exclusion of an integration.
Next to the three dots, there’s a star icon that lets you favorite integrations. Use this option to prioritize the integrations you want to see first, especially when there are many available.
If you don't use the "favorite" option, integrations will be displayed based on the most recent edit and the filters applied (e.g., ascending order).
To complete the sharing process, go to your chosen workspace and click on “All” in the “Integrations” area. Then, click the "Import" button. The newly shared module will be in the "Other spaces" tab. .
