About Connector Builder

As part of Integration Service, the Connector Builder enables you to quickly add custom connectors to your tenant catalog in a no-code environment. This is done by wrapping a vendor API into an Integration Service connector and therefore automatically provides rich and scalable functionality on top of that original API. The end result is a new connector within Integration Service that is available on your tenant. This connector exposes the API resources automatically as activities within Studio, allowing you to use it within your automation workflows.

When to use Connector Builder

Once you start building workflows using external data, you might run into scenarios where UiPath® has no prebuilt connectors or activities to help you solve a particular problem. Connector Builder allows you to add connectors to your catalog that are important to you, your co-workers, and your business processes.

A connector built through Connector Builder leverages the Integration Service framework for other connectors providing high re-usability within your workflows. It seamlessly connects with the larger UiPath ecosystem (Studio, Orchestrator, Assistant, etc.) and you can use the activities created for this connector just like any other activities.

Prerequisites

Connector Builder connects to external systems through their API, so the vendor API must be publicly exposed. This means that the APIs domain must allow for DNS resolution.

The vendor API must be REST-compliant and both accept and return JSON.

To authenticate and test a vendor API, make sure that you have the necessary permissions and access.

Tip: The vendor API documentation is extremely useful in providing details on authentication methods, available resources, request parameters, and fields. This information is required for completing a successful connector.

You must use Studio Desktop 2023.10 or above to consume the activities for your connector.