> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# UiPath

> How to set up the UiPath connector, plus the actions and events that are available.

![UiPath](https://stackone-logos.com/api/uipath/filled/svg)

Previewv0.2.0[See changelog](https://docs.stackone.com/connectors/uipath/changelog.md)

[74 actions](#actions) · [32 events](#events) · 4 auth methods

Automation
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 (Client Credentials) · Connector Profile](https://docs.stackone.com/connectors/uipath/guides/connector-profile/oauth-2-0-client-credentials.md)
>
> Requires a confidential external application with application scopes, registered in your own UiPath organization. App-on...

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/uipath/guides/connector-profile/oauth-2-0.md)
>
> Requires a confidential external application with user scopes, registered in your own UiPath organization. Calls run as...

> [card] [OAuth 2.0 (Authorization Code + PKCE) · Connector Profile](https://docs.stackone.com/connectors/uipath/guides/connector-profile/oauth-2-0-authorization-code-pkce.md)
>
> Requires a non-confidential external application with user scopes, registered in your own UiPath organization. No App Se...

> [card] [Personal Access Token · Connector Profile](https://docs.stackone.com/connectors/uipath/guides/connector-profile/personal-access-token.md)
>
> No external application required. The token carries the scopes and expiry date chosen when it was created, acts as the l...

Optionally, configure receiving Events for UiPath into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/uipath/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 (Client Credentials) · Link Account](https://docs.stackone.com/connectors/uipath/guides/link-account/oauth-2-0-client-credentials.md)

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/uipath/guides/link-account/oauth-2-0.md)

> [card] [OAuth 2.0 (Authorization Code + PKCE) · Link Account](https://docs.stackone.com/connectors/uipath/guides/link-account/oauth-2-0-authorization-code-pkce.md)

> [card] [Personal Access Token · Link Account](https://docs.stackone.com/connectors/uipath/guides/link-account/personal-access-token.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

OR.Assets.Read

OR.Assets.Write

OR.Buckets.Read

OR.Execution.Read

OR.Execution.Write

OR.Folders.Read

OR.Folders.Write

OR.Jobs.Read

OR.Jobs.Write

OR.Machines.Read

OR.Machines.Write

OR.Monitoring.Read

OR.Queues.Read

OR.Queues.Write

OR.Robots.Read

OR.Tasks.Read

OR.Tasks.Write

PM.Directory

PM.Group.Read

PM.Group.Write

PM.RobotAccount.Read

PM.RobotAccount.Write

PM.User.Read

PM.User.Write

No scopes found

74 actions

ActionDescriptionRequired scopes

List Groups`uipath_list_groups`

List the local and built-in groups of a UiPath organization.

`PM.Group.Read`

Get Group`uipath_get_group`

Get a UiPath group by ID.

`PM.Group.Read`

Create Group`uipath_create_group`

Create a local group in the organization.

`PM.Group.Write`

List Unified Groups`uipath_unified_list_groups`

List unified groups in a UiPath Automation Cloud organization.

`PM.Group.Read`

Get Unified Group`uipath_unified_get_group`

Get a unified UiPath group by ID.

`PM.Group.Read`

List Unified Roles`uipath_unified_list_roles`

List unified roles in a UiPath Automation Cloud organization.

Get Unified Role`uipath_unified_get_role`

Get a unified UiPath role by ID.

List Unified Users`uipath_unified_list_users`

List unified users in a UiPath Automation Cloud organization.

`PM.User.Read``PM.Group.Read`

Get Unified User`uipath_unified_get_user`

Get a unified UiPath user by ID.

`PM.User.Read`

List Assets`uipath_list_assets`

List the assets (shared settings and credentials) in a folder.

`OR.Assets.Read`

Get Asset`uipath_get_asset`

Get an asset by Id.

`OR.Assets.Read`

Create Asset`uipath_create_asset`

Create an asset in a folder.

`OR.Assets.Write`

Update Asset`uipath_update_asset`

Replace the value and settings of an asset.

`OR.Assets.Write`

Delete Asset`uipath_delete_asset`

Delete an asset.

`OR.Assets.Write`

List Buckets`uipath_list_buckets`

List the storage buckets in a folder.

`OR.Buckets.Read`

List Folders`uipath_list_folders`

List the Orchestrator folders the external application can see.

`OR.Folders.Read`

Get Folder`uipath_get_folder`

Get an Orchestrator folder by Id.

`OR.Folders.Read`

Create Folder`uipath_create_folder`

Create an Orchestrator folder.

`OR.Folders.Write`

List Jobs`uipath_list_jobs`

List the jobs in a folder, such as running, faulted or successful process runs.

`OR.Jobs.Read`

Get Job`uipath_get_job`

Get a job by Id, with its state and output arguments.

`OR.Jobs.Read`

Start Job`uipath_start_job`

Start a process by creating one or more jobs in a folder.

`OR.Jobs.Write`

Stop Job`uipath_stop_job`

Stop or kill a pending or running job.

`OR.Jobs.Write`

Stop Jobs`uipath_stop_jobs`

Stop or kill several jobs at once.

`OR.Jobs.Write`

Restart Job`uipath_restart_job`

Run a finished job again with the same process and arguments.

`OR.Jobs.Write`

List Robot Logs`uipath_list_robot_logs`

List the log messages robots wrote while running jobs in a folder.

`OR.Monitoring.Read`

List Processes`uipath_list_processes`

List the processes deployed to a folder.

`OR.Execution.Read`

Get Process`uipath_get_process`

Get a process deployed to a folder by Id.

`OR.Execution.Read`

List Packages`uipath_list_packages`

List the automation packages published to the tenant feed or a folder feed.

`OR.Execution.Read`

List Package Versions`uipath_list_package_versions`

List every published version of a package.

`OR.Execution.Read`

Get Package Arguments`uipath_get_package_arguments`

Get the input and output arguments a package version declares.

`OR.Execution.Read`

Create Process`uipath_create_process`

Deploy a package version as a process in a folder.

`OR.Execution.Write`

Update Process`uipath_update_process`

Replace the settings of a process.

`OR.Execution.Write`

Delete Process`uipath_delete_process`

Delete a process from a folder.

`OR.Execution.Write`

Upload Package`uipath_upload_package`

Upload a package, or a new version of a package, to a feed.

`OR.Execution.Write`

List Queues`uipath_list_queues`

List the queues in a folder.

`OR.Queues.Read`

Get Queue`uipath_get_queue`

Get a queue by Id.

`OR.Queues.Read`

Create Queue`uipath_create_queue`

Create a queue in a folder.

`OR.Queues.Write`

Update Queue`uipath_update_queue`

Replace the settings of a queue.

`OR.Queues.Write`

Delete Queue`uipath_delete_queue`

Delete a queue and its items.

`OR.Queues.Write`

List Queue Items`uipath_list_queue_items`

List queue items in a folder, such as the new or failed items of one queue.

`OR.Queues.Read`

Get Queue Item`uipath_get_queue_item`

Get a queue item by Id, with its status, data and output.

`OR.Queues.Read`

Add Queue Item`uipath_add_queue_item`

Add a work item to a queue for robots to process.

`OR.Queues.Write`

Bulk Add Queue Items`uipath_bulk_add_queue_items`

Add many work items to a queue in one call.

`OR.Queues.Write`

Update Queue Item`uipath_update_queue_item`

Replace the data of a queue item that is still New.

`OR.Queues.Write`

Delete Queue Item`uipath_delete_queue_item`

Delete a queue item that is still New.

`OR.Queues.Write`

Get Queue Item History`uipath_get_queue_item_history`

Get the processing history of a queue item, one record per attempt.

`OR.Queues.Read`

Set Queue Item Review Status`uipath_set_queue_item_review_status`

Set the review status of queue items.

`OR.Queues.Write`

List Robots`uipath_list_robots`

List the robots in a folder.

`OR.Robots.Read`

Get Robot`uipath_get_robot`

Get a robot by Id.

`OR.Robots.Read`

List Sessions`uipath_list_sessions`

List robot sessions in a folder, with each robot state such as Available, Busy or Disconnected.

`OR.Robots.Read`

List Machines`uipath_list_machines`

List the machines and machine templates of the tenant.

`OR.Machines.Read`

Get Machine`uipath_get_machine`

Get a machine by Id.

`OR.Machines.Read`

Create Machine`uipath_create_machine`

Create an Orchestrator machine or machine template.

`OR.Machines.Write`

List Tasks`uipath_list_tasks`

List Action Center tasks across every folder the application can see.

`OR.Tasks.Read`

Get Task`uipath_get_task`

Get an Action Center task by Id.

`OR.Tasks.Read`

Create Task`uipath_create_task`

Create an external Action Center task for a person to handle.

`OR.Tasks.Write`

Assign Tasks`uipath_assign_tasks`

Assign Action Center tasks to users.

`OR.Tasks.Write`

Complete Task`uipath_complete_task`

Complete an assigned Action Center task with an action and data.

`OR.Tasks.Write`

Delete Tasks`uipath_delete_tasks`

Delete Action Center tasks.

`OR.Tasks.Write`

List Triggers`uipath_list_triggers`

List the time and queue triggers that start processes in a folder.

`OR.Jobs.Read`

Get Trigger`uipath_get_trigger`

Get a trigger by Id.

`OR.Jobs.Read`

Enable Or Disable Triggers`uipath_set_triggers_enabled`

Turn one or more triggers on or off.

`OR.Jobs.Write`

Create Trigger`uipath_create_trigger`

Create a time or queue trigger for a process.

`OR.Jobs.Write`

Update Trigger`uipath_update_trigger`

Replace the settings of a trigger.

`OR.Jobs.Write`

Delete Trigger`uipath_delete_trigger`

Delete a trigger.

`OR.Jobs.Write`

List Robot Accounts`uipath_list_robot_accounts`

List the robot accounts of a UiPath organization.

`PM.RobotAccount.Read`

Get Robot Account`uipath_get_robot_account`

Get a UiPath robot account by ID.

`PM.RobotAccount.Read`

Create Robot Account`uipath_create_robot_account`

Create a robot account in the organization.

`PM.RobotAccount.Write`

Export User Role Assignments`uipath_export_user_role_assignments`

Export every role and role assignment of a UiPath organization.

Get Effective Access`uipath_get_effective_access`

Get the organization and tenant role assignments of one UiPath user, group or application.

List Users`uipath_list_users`

List the users of a UiPath organization with UiPath paging, search and sorting.

`PM.User.Read`

Get User`uipath_get_user`

Get a UiPath user by ID.

`PM.User.Read`

Search Directory`uipath_search_directory`

Search the UiPath organization directory for users, groups and applications by name prefix.

`PM.Directory`

Create User`uipath_create_user`

Create a local user in the organization.

`PM.User.Write`

## Events

Tags

Select all
|
Clear

Jobs

Machines

Processes

Queue Items

Queues

Robots

Tasks

Triggers

Verification

No tags found

32 events

EventDescriptionTags

Webhook Ping`uipath_webhook_ping`

Acknowledges an Orchestrator webhook ping without emitting an event.

Verification

Job Created Webhook`uipath_webhook_job_created`

Processes Orchestrator job.created events, sent when one or more jobs are created (started manually, by a trigger or thr...

Jobs

Job Started Webhook`uipath_webhook_job_started`

Processes Orchestrator job.started events, sent when a job starts running on a robot.

Jobs

Job Completed Webhook`uipath_webhook_job_completed`

Processes Orchestrator job.completed events, sent when a job finishes successfully.

Jobs

Job Faulted Webhook`uipath_webhook_job_faulted`

Processes Orchestrator job.faulted events, sent when a job finishes with an error.

Jobs

Job Stopped Webhook`uipath_webhook_job_stopped`

Processes Orchestrator job.stopped events, sent when one or more jobs are stopped or killed.

Jobs

Job Suspended Webhook`uipath_webhook_job_suspended`

Processes Orchestrator job.suspended events, sent when a long-running job is suspended to wait for an action or resume t...

Jobs

Schedule Failed Webhook`uipath_webhook_schedule_failed`

Processes Orchestrator schedule.failed events, sent when a time trigger fails to start its job; Reason holds the cause.

Triggers

Process Created Webhook`uipath_webhook_process_created`

Processes Orchestrator process.created events, sent when a process is created in a folder.

Processes

Process Updated Webhook`uipath_webhook_process_updated`

Processes Orchestrator process.updated events, sent when a process is updated, such as a new package version.

Processes

Process Deleted Webhook`uipath_webhook_process_deleted`

Processes Orchestrator process.deleted events, sent when a process is deleted.

Processes

Queue Created Webhook`uipath_webhook_queue_created`

Processes Orchestrator queue.created events, sent when a queue is created.

Queues

Queue Updated Webhook`uipath_webhook_queue_updated`

Processes Orchestrator queue.updated events, sent when a queue is updated.

Queues

Queue Deleted Webhook`uipath_webhook_queue_deleted`

Processes Orchestrator queue.deleted events, sent when a queue is deleted.

Queues

Queue Item Added Webhook`uipath_webhook_queue_item_added`

Processes Orchestrator queueItem.added events, sent when items are added to a queue.

Queue Items

Queue Item Transaction Started Webhook`uipath_webhook_queue_item_transaction_started`

Processes Orchestrator queueItem.transactionStarted events, sent when a robot starts processing a queue item.

Queue Items

Queue Item Transaction Completed Webhook`uipath_webhook_queue_item_transaction_completed`

Processes Orchestrator queueItem.transactionCompleted events, sent when a queue item transaction completes successfully.

Queue Items

Queue Item Transaction Failed Webhook`uipath_webhook_queue_item_transaction_failed`

Processes Orchestrator queueItem.transactionFailed events, sent when a queue item transaction fails with a business or a...

Queue Items

Queue Item Transaction Abandoned Webhook`uipath_webhook_queue_item_transaction_abandoned`

Processes Orchestrator queueItem.transactionAbandoned events, sent when a queue item is abandoned after 24 hours in prog...

Queue Items

Queue Item Retried Webhook`uipath_webhook_queue_item_retried`

Processes Orchestrator queueItem.retried events, sent when a queue item is retried after a failed attempt.

Queue Items

Robot Created Webhook`uipath_webhook_robot_created`

Processes Orchestrator robot.created events, sent when a robot is created.

Robots

Robot Updated Webhook`uipath_webhook_robot_updated`

Processes Orchestrator robot.updated events, sent when a robot is updated.

Robots

Robot Deleted Webhook`uipath_webhook_robot_deleted`

Processes Orchestrator robot.deleted events, sent when a robot is deleted.

Robots

Robot Status Changed Webhook`uipath_webhook_robot_status`

Processes Orchestrator robot.status events, sent when a robot session changes state (available, busy, disconnected or un...

Robots

Machine Session Status Changed Webhook`uipath_webhook_machine_session_status`

Processes Orchestrator machineSession.status events, sent when a machine session changes state.

Machines

Task Created Webhook`uipath_webhook_task_created`

Processes Orchestrator task.created events, sent when an Action Center task is created by a workflow or through the API.

Tasks

Task Updated Webhook`uipath_webhook_task_updated`

Processes Orchestrator task.updated events, sent when an Action Center task is updated.

Tasks

Task Assignment Changed Webhook`uipath_webhook_task_assignment_changed`

Processes Orchestrator task.assignmentChanged events, sent when a task assignee is added, changed or removed.

Tasks

Task Forwarded Webhook`uipath_webhook_task_forwarded`

Processes Orchestrator task.forwarded events, sent when a task is forwarded to another user.

Tasks

Task Saved Webhook`uipath_webhook_task_saved`

Processes Orchestrator task.saved events, sent when a task is saved before it is completed.

Tasks

Task Completed Webhook`uipath_webhook_task_completed`

Processes Orchestrator task.completed events, sent when a task is completed in Action Center.

Tasks

Task Deleted Webhook`uipath_webhook_task_deleted`

Processes Orchestrator task.deleted events, sent when a task is deleted.

Tasks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.