Connector Builder

The Connector Builder is a no-code API integration tool that lets you connect any Cloud app or custom service. Create custom connectors (packages) for various web applications or services that use APIs, and then use them in your automations.

Note:
  • Connector Builder is available with AWS and GCP for Cloud and On-Premises.
  • Connector Builder requires the Enterprise Platform license. For more information about supported versions for this feature, see Enterprise Platform.

Overview

Connectors or packages in the Control Room are the foundation of any type of automation. A package is built to perform certain tasks and the Control Room includes various packages to perform various tasks. While the Control Room provides various packages, you might want to build and use your packages or use third-party packages that are currently unavailable in the Control Room for your automations. A connector is a package that connects the Control Room with any application via API and can perform one or more operations in that application: for example, create or update resources. You will notice connector and package used interchangeably. They both refer to the custom integration you build with Connector Builder.

You can also import API definition files using Connector Builder to build custom connectors. Connector Builder supports Open API versions 2.x and 3.x.

File stream in Connector Builder

Connector Builder now supports file streaming, enabling you to create custom packages for file-based operations, that you can use in API Tasks. File streaming allows the packages to handle files directly from the data source. Streaming a binary file from the source eliminates the need to download and upload the files with individual actions.

Note:
  • There are no restrictions regarding the file type and size.
  • Currently, the GraphQL body parameters are not supported.
Actions with file download
For actions that involve file download, enable the Stream file(s) during download check box. Once you enable this check box, the system streams the file for download and you can assign a file variable to this file stream. This check box is available for all HTTPS methods.
Actions with file upload
For actions that involve file upload, add a relevant body parameter as per the API provider requirements. The action settings on the editor page display a browse file option.
If the API provider requires a binary file input, select Binary as the request body type. When you select Binary, it ensures that the system uses a file stream for the upload.
If the API provider requires a form data parameter in the request, select Form data as the request type and add a key with type as File. This allows you to select a file variable as the input for upload using the action you create.

You can also combine the custom packages with the pre-built file stream compatible packages in your API Tasks workflow. See File streaming using file variable for more information about in-built packages that support file streams.

Benefits

Connector Builder is useful in the following scenarios:

  • To create packages unavailable in the Control Room.
  • To create packages using private (in-house) APIs.
  • To include additional actions to the existing Packages available in the Control Room.
  • To create custom packages if the Packages that are available in the Control Room do not meet your requirements.

Workflow example

The following example describes how to create, edit, configure actions, and customize custom connectors:

  1. Crear conector personalizado
  2. Configurar acción en el editor de conectores
  3. Uso del editor de conectores
  4. Publicar conector personalizado
Connector Builder workflow
Note: When you create packages using the Connector Builder tool, you must manage the packages. Managing the packages includes updating the packages, publishing the packages, fixing any errors, and managing the package versions.

Resources