Case Description:
I need to connect a web form so that, once filled with the required data, each submission is sent as a new item into a Queue in UiPath Orchestrator.
A previous team implemented something similar, but unfortunately left no documentation. While reviewing the web form code, I found the following parameters being used:
uipath.client-id=uipath.refresh-token=uipath.scope=X-UIPATH-OrganizationUnitId=
Request:
Could someone guide me on how to properly set up this integration, or suggest a better solution for sending data from a web form into a UiPath Orchestrator Queue?
Based on the parameters you found, it looks like the previous team was integrating the web form with UiPath Orchestrator using the REST API and OAuth authentication.
Please check the below steps:
-
Create the Queue in Orchestrator
First make sure the target Queue is already created in UiPath Orchestrator and located in the correct folder.
-
Send form data to your backend/service
When the user submits the web form, the data should be sent to a backend service (for example a small API).
It is better not to call Orchestrator directly from the frontend.
3 .Generate an access token**
From your backend, generate an access token using the values you mentioned:
client-id
refresh-token
scope
This token will be used to authenticate with the Orchestrator API.
4.Specify the Orchestrator folder**
Include the header X-UIPATH-OrganizationUnitId in the API request.
This ensures the request is executed in the correct folder where the Queue exists.
5 .Add the Queue item
Call the Orchestrator Queue Items API to create a new transaction.
The form fields should be passed inside 'SpecificContent..
Example structure:
{
“itemData”: {
“Name”: “YourQueueName”,
“Priority”: “Normal”,
“SpecificContent”: {
“FullName”: “John Doe”,
“Email”: “john@example.com”,
“RequestType”: “New Request”
}
}
}
6.Process the item with a UiPath robot**
Once the item is added to the Queue, your UiPath process can pick it up and process the transaction.
Please let me know if it works
Regards,
Dhruba
Yes, I already have all that in context, I just don’t know how to connect the backend API to the orchestrator
This is the information I have or that the API code asks me for.
Yes — the backend connects to UiPath Orchestrator by making REST API calls.
Basic flow:
- Store these in backend config:
uipath.account-urluipath.client-iduipath.refresh-tokenuipath.scopeuipath.orchestrator-urlX-UIPATH-OrganizationUnitId
- When the web form is submitted, your backend sends a POST request to the UiPath token endpoint built from the account URL to get an
access_token.
- After receiving the token, the backend sends another POST request to the Orchestrator Queue API:
POST <uipath.orchestrator-url>/odata/QueueItems/UiPathODataSvc.AddQueueItem
- In that request, pass:
Authorization: Bearer <access_token>X-UIPATH-OrganizationUnitId: <folder_id>Content-Type: application/json
- Put the form values inside
SpecificContent in the request body.
So in simple terms, the connection is:
Web Form → Backend API → Get Access Token → Call Orchestrator Queue API
Excellent, we understand each other now.
My question is, I don’t know where to get all the data that’s entered in the backend configuration.
Please follow below . If this resolves your issue, please mark it as the solution so it can help others
Steps:
• Go to Automation Cloud
• Open Admin
• Go to External Applications
• Click Add Application
Enter Application name
Give any name, for example: WebFormQueueIntegration.
Select Application type
Choose Confidential application (recommended for backend APIs).
Add scopes
Click Add scopes and select the required Orchestrator permissions (for example queues or jobs depending on what you need).
Redirect URL
You can enter any valid URL
Click Add
After creating the application, UiPath will generate the values you need for your backend configuration, such as:
• Client ID
• Client Secret / Refresh Token
• Scopes
These are the values used by your backend to request an access token and then call the Orchestrator API to add queue items.
I only have a question regarding the URL. I noticed that the previous team used a UiPath URL, so I’m a bit confused about which URL I should enter here.
@alexis.mendoza.rpa For your use case (backend → Orchestrator using refresh token), the Redirect URL is not really used. It’s mainly required for OAuth flows involving user login (authorization code flow). So you can safely enter any valid URL, for example: https://localhost/callback https://yourapp.com/callback It does not need to be a UiPath URL, and it won’t impact your queue integration. The important values for your backend are Client ID, Refresh Token, Scopes, and Orchestrator URL.
