Elements

Experimental

Warning

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

Service for inspecting connector elements (objects, activities, trigger events, field schemas) on UiPath Integration Service.

The Elements API powers design-time tooling — every connector exposes a catalog of objects (resources like contacts, messages), activities (curated operations like Send Email), and event objects (trigger sources like New Message). Each can be inspected statically (connector-only) or scoped to a connection instance (which enriches the response with custom fields discovered from the live system).

Usage¶

Prerequisites: Initialize the SDK first - see Getting Started

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

const elements = new Elements(sdk);
const objects = await elements.getObjects('uipath-slack');

Methods¶

getActivities()¶

getActivities(elementKey: string, options?: ElementActivitiesGetOptions): Promise<ElementActivity[]>

Experimental

List curated activities exposed by a connector.

Warning

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

Parameters¶

Parameter	Type	Description
`elementKey`	`string`	Connector key
`options?`	`ElementActivitiesGetOptions`	Optional `version` to pin to a specific connector schema

Returns¶

Promise<ElementActivity[]>

Promise resolving to an array of ElementActivity

Example¶

const activities = await elements.getActivities('uipath-slack');
for (const activity of activities) {
  console.log(`${activity.name}: ${activity.operation} on ${activity.objectName}`);
}

getEventObjectMetadata()¶

getEventObjectMetadata(elementKey: string, operationName: string, objectName: string, options?: ElementEventObjectMetadataGetOptions): Promise<ElementEventObjectMetadataResponse>

Experimental

Get metadata for a single event object.

Warning

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

Parameters¶

Parameter	Type	Description
`elementKey`	`string`	Connector key
`operationName`	`string`	Event operation name
`objectName`	`string`	Event object name
`options?`	`ElementEventObjectMetadataGetOptions`	Optional `version`, `allFields`, `includeParentArray`

Returns¶

Promise<ElementEventObjectMetadataResponse>

Promise resolving to an ElementEventObjectMetadataResponse

Example¶

const meta = await elements.getEventObjectMetadata(
  'uipath-slack',
  'NEW_MESSAGE',
  'channels',
);

getEventObjects()¶

getEventObjects(elementKey: string, operationName: string, options?: ElementEventObjectsGetOptions): Promise<ElementEventObject[]>

Experimental

List event objects (trigger sources) for a connector's event operation.

Warning

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

Parameters¶

Parameter	Type	Description
`elementKey`	`string`	Connector key
`operationName`	`string`	Event operation name (e.g. `INDEX_COMPLETED`)
`options?`	`ElementEventObjectsGetOptions`	Optional `version`

Returns¶

Promise<ElementEventObject[]>

Promise resolving to an array of ElementEventObject

Example¶

const events = await elements.getEventObjects('uipath-slack', 'NEW_MESSAGE');

getInstanceEventObjectMetadata()¶

getInstanceEventObjectMetadata(connectionId: string, elementKey: string, operationName: string, objectName: string, options?: ElementEventObjectMetadataGetOptions): Promise<ElementEventObjectMetadataResponse>

Experimental

Get instance-scoped metadata for a single event object.

Warning

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

Parameters¶

Parameter	Type	Description
`connectionId`	`string`	Connection GUID
`elementKey`	`string`	Connector key
`operationName`	`string`	Event operation name
`objectName`	`string`	Event object name
`options?`	`ElementEventObjectMetadataGetOptions`	Optional `version`, `allFields`, `includeParentArray`

Returns¶

Promise<ElementEventObjectMetadataResponse>

Promise resolving to an ElementEventObjectMetadataResponse

Example¶

const meta = await elements.getInstanceEventObjectMetadata(
  '<connectionId>',
  'uipath-slack',
  'NEW_MESSAGE',
  'channels',
);

getInstanceEventObjects()¶

getInstanceEventObjects(connectionId: string, elementKey: string, operationName: string, options?: ElementEventObjectsGetOptions): Promise<ElementEventObject[]>

Experimental

List event objects for a connection instance.

Warning

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

Parameters¶

Parameter	Type	Description
`connectionId`	`string`	Connection GUID
`elementKey`	`string`	Connector key
`operationName`	`string`	Event operation name
`options?`	`ElementEventObjectsGetOptions`	Optional `version`

Returns¶

Promise<ElementEventObject[]>

Promise resolving to an array of ElementEventObject

Example¶

const events = await elements.getInstanceEventObjects(
  '<connectionId>',
  'uipath-slack',
  'NEW_MESSAGE',
);

getInstanceObjectMetadata()¶

getInstanceObjectMetadata(connectionId: string, elementKey: string, objectName: string, options?: ElementObjectMetadataGetOptions): Promise<ElementObjectMetadataResponse>

Experimental

Get instance-scoped metadata for a single object — includes connector custom fields discovered from the live system.

Warning

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

Parameters¶

Parameter	Type	Description
`connectionId`	`string`	Connection GUID
`elementKey`	`string`	Connector key
`objectName`	`string`	Object name
`options?`	`ElementObjectMetadataGetOptions`	Optional `version`, `hydrateParameters`, `includeParentArray`

Returns¶

Promise<ElementObjectMetadataResponse>

Promise resolving to an ElementObjectMetadataResponse

Example¶

const meta = await elements.getInstanceObjectMetadata(
  '<connectionId>',
  'uipath-salesforce',
  'Account',
);

getInstanceObjects()¶

getInstanceObjects(connectionId: string, elementKey: string, options?: ElementObjectsGetOptions): Promise<ElementObject[]>

Experimental

List objects exposed by a connection instance (includes connector custom fields discovered from the live system).

Warning

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

Parameters¶

Parameter	Type	Description
`connectionId`	`string`	Connection GUID
`elementKey`	`string`	Connector key
`options?`	`ElementObjectsGetOptions`	Filtering options

Returns¶

Promise<ElementObject[]>

Promise resolving to an array of ElementObject

Example¶

const objects = await elements.getInstanceObjects('<connectionId>', 'uipath-slack');

getObjectMetadata()¶

getObjectMetadata(elementKey: string, objectName: string, options?: ElementObjectMetadataGetOptions): Promise<ElementObjectMetadataResponse>

Experimental

Get metadata for a single connector object (field schema, supported methods, parameters). Connection-independent — returns the standard schema only.

Warning

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

Parameters¶

Parameter	Type	Description
`elementKey`	`string`	Connector key
`objectName`	`string`	Object name (e.g. `messages`)
`options?`	`ElementObjectMetadataGetOptions`	Optional `version`, `hydrateParameters`, `includeParentArray`

Returns¶

Promise<ElementObjectMetadataResponse>

Promise resolving to an ElementObjectMetadataResponse

Example¶

const meta = await elements.getObjectMetadata('uipath-slack', 'messages');
console.log(`Fields: ${Object.keys(meta.fields ?? {}).length}`);

getObjects()¶

getObjects(elementKey: string, options?: ElementObjectsGetOptions): Promise<ElementObject[]>

Experimental

List objects (resources) exposed by a connector.

Warning

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

Parameters¶

Parameter	Type	Description
`elementKey`	`string`	Connector key (e.g. `uipath-slack`)
`options?`	`ElementObjectsGetOptions`	Filtering options (type, subtype, hasEvents, hasBulk)

Returns¶

Promise<ElementObject[]>

Promise resolving to an array of ElementObject

Examples¶

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

const elements = new Elements(sdk);

const objects = await elements.getObjects('uipath-slack');
for (const obj of objects) {
  console.log(`${obj.name} — ${obj.displayName}`);
}

// Only objects that support events
const eventCapable = await elements.getObjects('uipath-slack', { hasEvents: true });