Developer Guide

Last updated Oct 25, 2024

Integration FAQ

Where can I download the UiPath platform?

UiPath Studio & Robot: Click here to download.
UiPath Orchestrator: You may use our shared cloud edition of Orchestrator at https://cloud.uipath.com, which supports 2 robots per tenant. Sign up at the bottom of the homepage.

If you would prefer a private instance of Orchestrator, contact us for a trial license.

How do I integrate with UiPath's platform?

To integrate from your platform to UiPath's, use the Connectors Guide.

To integrate from UiPath to your platform, learn how to create activities.

How do I use the Orchestrator API?

There are 3 documents that tell you all you need to know about the Orchestrator API:

The best place to start though is with the Postman collection, which can be used out of the box to make API calls to Orchestrator. It handles all authentication/token refreshing and walks you step-by-step through the most common processes.

What features should I integrate?

The two most used functions are Adding to a Queue and Starting a Job. If you only cover these two, you will satisfy the majority of uses.

Other valuable functions are Creating & Updating Assets, Creating a Queue, Retrieving Queue Outputs, Retrieving Job Outputs, Checking Robot Status.

How do I start a Job in Orchestrator via the API?

Typically, you would be doing the following:

Authenticate
Grab the Release key of the process you wish to start.
Grab the ID of the Robot on which to run the process.
OPTIONAL: Set input data to feed to the robot process by writing it to a Queue or to an Asset.
Start a job using the Release key and a Robot ID gathered earlier. The Robot will pull an item from the Queue or Asset if indicated.
Alternatively, you can directly start a job with input parameters.

Can Jobs accept input arguments?

Yes, as of 2018.3, jobs accept input arguments of primitive types (integer, string, boolean) and may also output values.

Here is documentation on the feature and a sample API call.

How do I know when a job has finished running or when a queue item has been processed?

You have three options:

Set up a webhook that alerts you immediately after a job has finished or queue item has been processed. Here's how you set one up.
Poll the Orchestrator API at regular intervals to check the status.
At the end of your workflow, add an HTTP Request activity that calls back to the partner platform with the desired information.

Platform.uipath.com is down/I'm not able to connect to the Orchestrator.

In case of an out outage, the most immediate source of information and status updates is https://status.uipath.com.
If there is no outage, please refer to the Orchestrator docs and technical support.

How do I build a custom activity?

Here are some resources to get started:

Can I have some sample workflows to use for testing?

Of course! Here are 2 simple workflows:

Hello - A simple Hello World process that displays a message box with the phrase “Hello Beautiful People”. If you are connected to an Orchestrator with an Asset named greeting, the message box will instead display the value of this Asset. Finally, if you call this process via the API and send an input string named greeting, this value will instead be displayed.

Topics covered: Job Inputs/Outputs, Assets, Workflow Variables
Calculator - A process that pulls two addends from the Addends Queue in Orchestrator, opens the Windows calculator app, adds the two numbers, and puts the sum in the output field of the Queue. If there are no transaction items in the Addends Queue, one will be created with 10 & 12 as the two inputs. If the Queue does not exist, it must be manually created within Orchestrator.