orchestrator

latest

false

Getting started
- Introduction
- Robots
  - Robot Statuses
  - Robot Settings
- Auto Updating Client Components
- Time-to-live Periods
- Orchestrator Outbound IP Addresses
- Notifications
Best practices
- Organization Modeling in Orchestrator
- Automation Best Practices
- Optimizing Unattended Infrastructure Using Machine Templates
- Unattended automation
- Organizing Resources With Tags
- Orchestrator Read-only Replica
- Exporting grids in the background
Tenant
- About the Tenant Context
- Searching for Resources in a Tenant
- Robots
- Folders
- Monitoring
- Access control
- Configuring automation capabilities
  - Enabling personal automations
    - Enabling individual users to run personal automations
- Machines
- Packages
- Audit
- Credential Stores
  - Integrating credential stores
  - Managing credential stores
- Webhooks
  - Types of Events
  - Managing Webhooks
- Licensing
  - Managing Your Licenses
- Settings
  - Robot Security Tab
  - Scalability Tab
    - SignalR (Robots)
Cloud robots
- Automation Cloud™ Robots - VM
- Configuring VPN for cloud robots
- My notifications
Folders Context
- About the Folders Context
- Home
Automations
- About Automations
Processes
- About Processes
- Managing Processes
- Managing Package Requirements
- Recording
Jobs
- About Jobs
- Managing Jobs
- Job States
- Working with long-running workflows
- Running Personal Remote Automations
- Process Data Retention Policy
Apps
- About Apps
- Publishing an App to a Tenant
- Managing Apps
- Running a Deployed App from a Folder
Triggers
- About triggers
- Managing triggers
- Managing Non-Working Days
- Using Cron Expressions
  - Triggering jobs on the last day of the month
Logs
- About Logs
- Managing Logs in Orchestrator
- Logging Levels
Monitoring
- About Monitoring
- Machines
- Processes
- Queues
- Queues SLA
Queues
- About Queues and Transactions
- Bulk uploading Queue Items using a CSV file
- Managing Queues in Orchestrator
- Managing Queues in Studio
- Managing Transactions
  - Editing Transactions
  - Field Descriptions for the Transactions .csv File
- Review Requests
Assets
- About Assets
- Managing Assets in Orchestrator
- Managing Assets in Studio
- Storing Assets in Azure Key Vault (read only)
- Storing Assets in HashiCorp Vault (read only)
- Storing Assets in AWS Secrets Manager (read only)
Storage Buckets
- About Storage Buckets
  - CORS/CSP Configuration
- Managing Storage Buckets
Test Suite - Orchestrator
- Test Automation
- Test Cases
  - Field Descriptions for the Test Cases Page
- Test Sets
  - Field Descriptions for the Test Sets Page
- Test Executions
  - Field Descriptions for the Test Executions Page
- Test Schedules
  - Field Descriptions for the Test Schedules Page
- Test Data Queues
- Testing Data Retention Policy
Resource Catalog Service
- About Resource Catalog Service
Authentication
- About Authentication
Integrations
- About Input and Output Arguments
  - Example of Using Input and Output Arguments
Classic Robots
- Robots
- Environments
  - Managing Environments
- Jobs
- Triggers
- Monitoring
  - Robots
- Resources
Troubleshooting
- About Troubleshooting
- Frequently Encountered Orchestrator Errors

Orchestrator User Guide

DELIVERY:

DELIVERY:

Automation Cloud Automation Cloud Public Sector Automation Suite Standalone

Last updated Oct 30, 2024

API triggers

API triggers offer a streamlined way of starting a job via HTTP, through a custom request URL created by you. They work as a layer wrapped around existing processes, and leverage the options that are already available for triggers.

Once you create an API trigger, you can easily start a job in an external application and consume its output.

Authentication

API trigger invocations and calls are authorized through personal access tokens.

All you need to do is generate a token that you can use to access the resources you need, and use the token in your requests.

Once generated and copied, you can paste it in your bearer token field to authorize job requests.

Permissions

These are the permissions you need to perform operations on API triggers:

Triggers permission at the folder level (this dictates the actions you can take on API triggers):
- View - allows you to see API triggers within your tenant.
- Edit - allows you to make changes to API triggers.
- Create - allows you to create API triggers.
- Delete - allows you to delete API triggers.
Jobs permission at the folder level (this is required to invoke a job trigger and follow the job execution until the result is available):
- Create - allows you to start an API call based on an API trigger.
- View - allows you to view the status of the API request.

On this page

Authentication
Permissions

Was this page helpful?

PREVIOUSEvent triggers

NEXTCall modes explained

Support and Services

Get The Help You Need

Learning RPA - Automation Courses

UiPath Community Forum

Trust and Security

© 2005-2024 UiPath. All rights reserved.