- Getting started
- Best practices
- Tenant
- About the Tenant Context
- Searching for Resources in a Tenant
- Managing Robots
- Connecting Robots to Orchestrator
- Storing Robot Credentials in CyberArk
- Storing Unattended Robot Passwords in Azure Key Vault (read only)
- Storing Unattended Robot Credentials in HashiCorp Vault (read only)
- Storing Unattended Robot Credentials in AWS Secrets Manager (read only)
- Deleting Disconnected and Unresponsive Unattended Sessions
- Robot Authentication
- Robot Authentication With Client Credentials
- Configuring automation capabilities
- Audit
- Settings
- Cloud robots
- Folders Context
- Automations
- Processes
- Jobs
- Apps
- Triggers
- Logs
- Monitoring
- Queues
- Assets
- Storage Buckets
- Test Suite - Orchestrator
- Resource Catalog Service
- Authentication
- Integrations
- Classic Robots
- Troubleshooting
Managing API triggers
-
Tenant-level execution settings apply to API triggers.
-
You can create a maximum of 1.000 API triggers per tenant.
The API Triggers page allows you to perform several actions from the contextual menu of each trigger:
Copy the URL to be used in the third-party application.
hw-process
slug, it would look like this: https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/t/6ea73196-ca89-446c-81e1-5279bdd36dc2/hw-process
Copy the slug in the appropriate format for use in the command line or in existing code. The available options are:
hw-process
slug, it would look like this:
curl '{baseURL_orchestrator}/t/6ea73196-ca89-446c-81e1-5279bdd36dc2/hw-process' -X 'POST' -H 'Content-Type: application/json' -H 'Authorization: Bearer ***INSERT_YOUR_TOKEN***'
curl '{baseURL_orchestrator}/t/6ea73196-ca89-446c-81e1-5279bdd36dc2/hw-process' -X 'POST' -H 'Content-Type: application/json' -H 'Authorization: Bearer ***INSERT_YOUR_TOKEN***'
hw-process
slug, it would look like this:
curl "https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/t/6ea73196-ca89-446c-81e1-5279bdd36dc2/hw-process" ^ -X "POST" ^ -H "Content-Type: application/json" ^ -H "Authorization: Bearer ***INSERT_YOUR_TOKEN***"
curl "https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/t/6ea73196-ca89-446c-81e1-5279bdd36dc2/hw-process" ^ -X "POST" ^ -H "Content-Type: application/json" ^ -H "Authorization: Bearer ***INSERT_YOUR_TOKEN***"
hw-process
slug, it would look like this:
fetch("https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/t/6ea73196-ca89-446c-81e1-5279bdd36dc2/hw-process", { headers: { Authorization: "Bearer ***INSERT_YOUR_TOKEN***", "Content-Type": "application/json" }, "method": "POST" })
fetch("https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/t/6ea73196-ca89-446c-81e1-5279bdd36dc2/hw-process", { headers: { Authorization: "Bearer ***INSERT_YOUR_TOKEN***", "Content-Type": "application/json" }, "method": "POST" })
hw-process
slug, it would look like this:
$headers = @{ "method"="POST" "Authorization" = "Bearer ***INSERT_YOUR_TOKEN***" } Invoke-WebRequest -UseBasicParsing -Uri "https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/t/6ea73196-ca89-446c-81e1-5279bdd36dc2/hw-process" ` -Headers $headers ` -ContentType "application/json"
$headers = @{ "method"="POST" "Authorization" = "Bearer ***INSERT_YOUR_TOKEN***" } Invoke-WebRequest -UseBasicParsing -Uri "https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/t/6ea73196-ca89-446c-81e1-5279bdd36dc2/hw-process" ` -Headers $headers ` -ContentType "application/json"
Remove the selected API trigger. Deleting an API trigger is equivalent to deleting the resulting endpoint. These are the behaviors that you can expect depending on your particular scenario:
Already started jobs
If a job based on a process associated to a deleted API trigger is already started at the time of deletion, it is carried out to completion.
Starting new jobs
Since the URL is no longer available, trying to start a job based on a process associated to a deleted API trigger results in a 404 error.
Editing processes
If you edit a process that is used by at least one API trigger, the trigger is refreshed and the new set of process properties are applied.
You can add domains to the allowlist for incoming traffic by using the CORS allow list for API triggers option on the General tab of your tenant settings.
This is required for browser applications that will make HTTP requests to Orchestrator from your browser (i.e. not from a server). Failing to allowlist domains could lead to a CORS policy error, which you can see in your developer console.
If you want to allowlist more domains, use a comma or press Enter to separate them.
This page displays a swagger definition of the API triggers you have created, grouped by folder, along with their output. In addition to that, it allows you to execute the jobs pertaining to those triggers.