ExamFinch.com My Study

Study guide

21.4 Connector Builder: Custom Integration Service Connectors

Practice this exam

UiPath Automation Developer Professional UiPath-ADPv1

Track your progress as you read

Finished sections get a check mark.

1 Chapter 1: Exam Overview & Blueprint Map

1.1 About the UiPath-ADPv1 Exam: Format, Fees & Policies 1.2 The Exam Topics Mapped to This Guide & a Study Plan

2 Chapter 2: REFramework Architecture & State Dynamics

2.1 State Machine Architecture & The Four Core States 2.2 Configuration Management: Settings, Constants, and Assets 2.3 Transaction Types & The Dispatcher vs. Performer Architecture 2.4 Adapting REFramework: Tabular Data, Collections & Linear Processes

3 Chapter 3: REFramework Exception Handling & Recovery

3.1 BusinessRuleException vs. System.Exception Handling Patterns 3.2 Retry Mechanisms: Queue Retries vs. REFramework MaxRetryNumber 3.3 Consecutive System Exceptions & Graceful Process Termination

4 Chapter 4: State Machines, Custom Log Fields & REFramework Testing

4.1 Building State Machine Projects in Studio 4.2 Logging Levels, Robot Logs & Custom Log Fields in REFramework 4.3 Testing a REFramework Project With and Without Orchestrator Queues

5 Chapter 5: LINQ Queries & DataTable Operations

5.1 LINQ Essentials for Collections & Filtering 5.2 Advanced DataTable Querying with LINQ 5.3 In-Memory DataTable Transformations & Column Operations

6 Chapter 6: Regex, DateTime, JSON & Invoke Activities

6.1 Regular Expressions & Text Parsing for Automation 6.2 DateTime Formatting, Timezone Conversions & TimeSpan Calculations 6.3 JSON Parsing, JSONPath & Serialization with Newtonsoft.Json 6.4 Invoke Method & Invoke Code Activities 6.5 Data Referencing in Invokes: DataTable, List & Dictionary Arguments

7 Chapter 7: Modern UI Automation & Unified Targeting

7.1 Modern Design Experience & The Unified Target Concept 7.2 Anchors, Relative Elements & UI Automation Activities 7.3 Dynamic Selectors, Variables & Wildcards in Selectors

8 Chapter 8: Object Repository, Computer Vision & Remote Runtime

8.1 Object Repository & UI Descriptor Libraries 8.2 AI Computer Vision for Unattended & Remote Interfaces 8.3 Automation in Virtual Environments & UiPath Remote Runtime

9 Chapter 9: Advanced UI Automation: Browser Modes, Agentic UI & macOS

9.1 Browser Automation with the WebDriver Protocol 9.2 Agentic UI Automation: ScreenPlay, Semantic Activities & Healing Agent 9.3 macOS Automation: Native Apps, Office Apps & AppleScript

10 Chapter 10: Advanced Control Flow & Exception Architecture

10.1 Flowcharts, Sequences & Parallel Control Flow Patterns 10.2 Global Exception Handler Architecture & ErrorAction Directives 10.3 TryCatch, Retry Scope & Custom Exception Architectures

11 Chapter 11: Orchestrator Queues & Transaction Management

11.1 Queue Architecture, SpecificContent & Transaction Lifecycles 11.2 Queue Items SLA, Postpone, Deadlines & Priority Scheduling 11.3 Bulk Operations, Transaction Status Updates & Queue Triggers

12 Chapter 12: Orchestrator Tenant & Folder Entities

12.1 Asset Types, Per-Robot Assets & External Credential Stores 12.2 Modern Folder Hierarchy, User/Robot Assignment & Permissions 12.3 Storage Buckets, Webhooks & Environment Promotion 12.4 Orchestrator Tags: Labels, Properties & Governance

13 Chapter 13: Unattended Execution, API Triggers & Cloud Robots

13.1 Unattended Job Execution: Folders, Priorities, Background vs. Foreground & Runtimes 13.2 API Triggers: Starting Jobs from External Systems over HTTP 13.3 Serverless and Cloud VM Robots: Cloud-Hosted Execution Options

14 Chapter 14: Monitoring, Recording & Solutions Management

14.1 Orchestrator Monitoring, Trigger Alerts & Job Health 14.2 Job and Transaction Recording: Troubleshooting Faulted Unattended Jobs 14.3 Solutions Management: Packaging and Deploying Automations with Their Resources

15 Chapter 15: Debugging, Remote Debugging & Profiling

15.1 Studio Debugging Tools: Breakpoints, Panels & Execution Control 15.2 Remote Debugging: Remote Machine and Unattended Robot Connections 15.3 Profile Execution: Finding Performance Bottlenecks in Studio

16 Chapter 16: RPA Testing & Test Suite

16.1 UiPath Test Suite Overview, Test Cases & Given-When-Then Structure 16.2 Data-Driven Testing, Test Verification Activities & Mock Activities 16.3 CI/CD Pipelines with uipcli & Test Manager Traceability

17 Chapter 17: Long-Running Workflows, Action Center & Apps

17.1 Long-Running Workflows: Persistence, Suspend and Resume 17.2 Action Center & Human-in-the-Loop Orchestration 17.3 UiPath Apps: Action Apps, Automations & Integration Service

18 Chapter 18: Trigger-Based Attended Automation & Callouts

18.1 Trigger-Based Attended Automation: Forms, Triggers & Global Variables 18.2 Running Local Triggers & the Event Inspection Tool 18.3 Callouts & Forms for Attended Guidance

19 Chapter 19: UiPath Assistant & Robot Sessions

19.1 UiPath Assistant: Automations, Reminders, Widgets & Configuration 19.2 Robot Session (Picture in Picture): Child Session vs. Virtual Desktop

20 Chapter 20: Autopilot for Developers & Autopilot for Everyone

20.1 Autopilot for Developers: AI Assistance in Studio and Studio Web 20.2 Autopilot for Everyone: Chat, Automations & Clipboard AI

21 Chapter 21: API Automation & Integration Service

21.1 Integration Service: Connectors, Connections & Connector Activities 21.2 API Workflows in Studio Web 21.3 HTTP Requests: Web APIs, the Orchestrator API & Connector Requests 21.4 Connector Builder: Custom Integration Service Connectors 21.5 Integration Service Event Triggers: Connected and Disconnected 21.6 GenAI Activities: Generative AI Inside Workflows

22 Chapter 22: Data Service, Context Grounding & Coded Workflows

22.1 Data Fabric (Data Service) Entities: Modeling Business Data 22.2 Data Fabric Activities and the Platform Connector 22.3 Context Grounding: Retrieval-Augmented Generation with Company Data 22.4 Coded Automations: Structure, Arguments & Invoking Workflows 22.5 Coded Automation Services: Orchestrator, UI Automation, Microsoft 365 & Custom Services

23 Chapter 23: Integrated Scenario Practice

23.1 Integrated Scenario Practice: Designing an End-to-End Solution

21.4 Connector Builder: Custom Integration Service Connectors

Key Takeaways Explain This Topic AI

Connector Builder creates custom Integration Service connectors for REST APIs that use JSON.

Connectors can start from scratch or from an API definition such as Swagger/OpenAPI or a Postman collection.

The connector defines authentication (for example API key, basic, or OAuth 2.0 client credentials), resources, methods, fields, and pagination.

Global Scripts in JavaScript adjust requests and responses; methods are tested before publishing.

Published connectors appear in the tenant catalog and work in Studio (2023.10+) and Studio Web like prebuilt connectors, with credentials kept in connections.

Last updated: September 2026

21.4 Connector Builder: Custom Integration Service Connectors

Core Concept: When an application has a REST API but no prebuilt connector, Connector Builder lets you create a custom connector for Integration Service. Once published, it works like any other connector: connections, activities in Studio and Studio Web, and the connection-based HTTP Request.

When to Build a Connector

  • Situation Better choice
  • A prebuilt connector exists Use it
  • One or two calls in a single project A plain HTTP Request may be enough
  • A REST/JSON API used repeatedly, by several developers or projects Build a connector
  • The API needs central credential handling and token refresh Build a connector

Connector Builder targets REST APIs that use JSON .

Creating a Connector

You can start a connector in several ways:

From scratch , defining the base URL, authentication, and resources yourself.

From an API definition , importing a Swagger/OpenAPI file (JSON or YAML) or a Postman collection, which creates resources and methods automatically.

Authentication

Choose how the connector authenticates, for example with an API key , basic credentials, or OAuth 2.0 flows such as authorization code or client credentials . Users then create connections with that method, and Integration Service stores and refreshes the tokens.

Resources and methods

Each resource (for example /customers ) gets methods such as GET list, GET by ID, POST, PATCH, and DELETE. For each method you define:

  • path and query parameters, with which fields are required,
  • the request body fields and the response fields,

pagination settings for list operations.

These definitions become the fields that appear in the connector's activities.

Scripting

Global Scripts in JavaScript let you adjust requests and responses, for example to add a computed header or to reshape a response before it reaches the activity.

Testing

Test each method against the real API from the builder, using a test connection, before publishing.

Publishing and Using the Connector

Publish the connector to the tenant . It then appears in the connector catalog for that tenant.

Users create connections to it in their folders or Personal Workspaces.

In Studio (2023.10 and later) and Studio Web, the connector's activities appear like those of prebuilt connectors, and its HTTP Request activity reuses the connection.

In Orchestrator, per-environment connections are chosen through Package Requirements , as for any connector.

Design Guidelines

Name resources and fields for business users , for example "Customer" and "Credit limit" rather than raw API names.

Mark required fields so the activities validate input before calling the API.

Keep secrets out of the connector definition. Credentials belong in connections.

Version deliberately. Changing a published method's fields can break automations; add new methods or fields rather than renaming existing ones.

Document limits such as rate limits and page sizes in the resource descriptions.

Worked Example: An Internal Asset-Tracking API

A company's asset-tracking system exposes a REST API with an OpenAPI file and OAuth 2.0 client credentials.

The developer imports the OpenAPI file into Connector Builder, which creates /assets and /assignments resources.

They choose client credentials authentication and set the token URL.

They rename fields for readability, mark assetTag as required, and configure pagination for the list method.

A Global Script adds a X-Source: UiPath header that the API team requested.

They test each method, publish to the tenant, and create a service-account connection in the shared IT folder.

Automations now use activities such as "Get asset" and "Create assignment" instead of hand-built HTTP requests.

Key Terms

Resource: an API object such as /customers , grouping related methods.

Method: one operation on a resource, such as GET by ID or POST, which becomes an activity.

Global Script: JavaScript that runs around requests and responses for the whole connector.

Connection: a user's authenticated instance of the connector, stored in an Orchestrator folder or Personal Workspace.

Connector Builder Versus Other Options

Option Strength Limitation

Custom connector Reusable activities, central connections, token refresh, use in triggers where events are defined Takes time to design and maintain

  • HTTP Request in each project Quick for one-off calls Credentials and parsing repeated in every project
  • API workflow with HTTP activities Fast headless integrations Still needs a way to authenticate each call

A custom connector pays off when several automations use the same API. For a single call in one project, a plain HTTP request is usually enough.

Common Traps

Building a connector for an API that is not REST/JSON.

Putting credentials into the connector definition instead of connections.

Forgetting to publish to the tenant before looking for the connector in Studio.

Renaming published fields and breaking existing automations.