Connectors

Experimental

Warning

Preview: This service is experimental and may change or be removed in future releases.

Service for inspecting UiPath Integration Service connectors.

Connectors are the catalog of integrations available on a tenant (Slack, Microsoft 365, Salesforce, custom connectors, ...). Use this service to discover connectors, fetch their metadata, and list / locate the connection instances built on top of them.

Usage¶

Prerequisites: Initialize the SDK first - see Getting Started

import { Connectors } from '@uipath/uipath-typescript/connections';

const connectors = new Connectors(sdk);
const allConnectors = await connectors.getAll();

Methods¶

getAll()¶

getAll(options?: ConnectorGetAllOptions): Promise<ConnectorGetResponse[]>

Experimental

List all connectors available on this tenant.

Warning

Preview: This method is experimental and may change or be removed in future releases.

Returns a plain array — the Integration Service does not paginate this endpoint.

Parameters¶

Parameter	Type	Description
`options?`	`ConnectorGetAllOptions`	Optional filter (e.g. limit to connectors exposing HTTP Request activities)

Returns¶

Promise<ConnectorGetResponse[]>

Promise resolving to an array of ConnectorGetResponse

Examples¶

import { Connectors } from '@uipath/uipath-typescript/connections';

const connectors = new Connectors(sdk);

const all = await connectors.getAll();
for (const connector of all) {
  console.log(`${connector.key} — ${connector.name} (${connector.lifeCycleStage})`);
}

// Only connectors that expose an HTTP Request activity
const httpEnabled = await connectors.getAll({ hasHttpRequest: true });

getById()¶

getById(keyOrId: string): Promise<ConnectorGetResponse>

Experimental

Get a single connector by key or numeric ID.

Warning

Preview: This method is experimental and may change or be removed in future releases.

Parameters¶

Parameter	Type	Description
`keyOrId`	`string`	Connector key (e.g. `uipath-slack`) or numeric ID as a string

Returns¶

Promise<ConnectorGetResponse>

Promise resolving to a ConnectorGetResponse

Example¶

import { Connectors } from '@uipath/uipath-typescript/connections';

const connectors = new Connectors(sdk);

const slack = await connectors.getById('uipath-slack');
console.log(slack.name, slack.authentication?.type);

getConnections()¶

getConnections(keyOrId: string, options?: ConnectorGetConnectionsOptions): Promise<ConnectionGetResponse[]>

Experimental

List all connections for a connector.

Warning

Preview: This method is experimental and may change or be removed in future releases.

Returns a plain array — the Integration Service uses page-indexed pagination (no continuation cursor). Increment pageIndex to walk pages.

Parameters¶

Parameter	Type	Description
`keyOrId`	`string`	Connector key or numeric ID as a string
`options?`	`ConnectorGetConnectionsOptions`	Folder scoping (`folderId` / `folderKey` / `folderPath`), paging, and sorting options

Returns¶

Promise<ConnectionGetResponse[]>

Promise resolving to an array of ConnectionGetResponse

Examples¶

import { Connectors } from '@uipath/uipath-typescript/connections';

const connectors = new Connectors(sdk);

// First page of Slack connections in a folder
const slackConnections = await connectors.getConnections('uipath-slack', {
  folderKey: '<folderKey>',
  pageSize: 25,
});

for (const conn of slackConnections) {
  console.log(`${conn.name}: ${conn.state}`);
}

// Walk subsequent pages
const page2 = await connectors.getConnections('uipath-slack', {
  folderId: 123,
  pageSize: 25,
  pageIndex: 2,
});

getDefaultConnection()¶

getDefaultConnection(keyOrId: string, options?: ConnectorGetDefaultConnectionOptions): Promise<ConnectionGetResponse>

Experimental

Get the default connection for a connector in the current folder.

Warning

Preview: This method is experimental and may change or be removed in future releases.

Each connector may have a single connection marked as default per folder; use this to resolve "which connection should I use for Slack?" without paging through the full list.

Parameters¶

Parameter	Type	Description
`keyOrId`	`string`	Connector key or numeric ID as a string
`options?`	`ConnectorGetDefaultConnectionOptions`	Folder scoping (`folderId` / `folderKey` / `folderPath`)

Returns¶

Promise<ConnectionGetResponse>

Promise resolving to a ConnectionGetResponse

Example¶

import { Connectors } from '@uipath/uipath-typescript/connections';

const connectors = new Connectors(sdk);

const defaultSlack = await connectors.getDefaultConnection('uipath-slack', {
  folderPath: 'Shared/Finance',
});

console.log(defaultSlack.name, defaultSlack.state);