ExamFinch.com My Study

Study guide

13.2 API Triggers: Starting Jobs from External Systems over HTTP

Practice this exam

UiPath Automation Developer Professional UiPath-ADPv1

Track your progress as you read

Finished sections get a check mark.

1 Chapter 1: Exam Overview & Blueprint Map

1.1 About the UiPath-ADPv1 Exam: Format, Fees & Policies 1.2 The Exam Topics Mapped to This Guide & a Study Plan

2 Chapter 2: REFramework Architecture & State Dynamics

2.1 State Machine Architecture & The Four Core States 2.2 Configuration Management: Settings, Constants, and Assets 2.3 Transaction Types & The Dispatcher vs. Performer Architecture 2.4 Adapting REFramework: Tabular Data, Collections & Linear Processes

3 Chapter 3: REFramework Exception Handling & Recovery

3.1 BusinessRuleException vs. System.Exception Handling Patterns 3.2 Retry Mechanisms: Queue Retries vs. REFramework MaxRetryNumber 3.3 Consecutive System Exceptions & Graceful Process Termination

4 Chapter 4: State Machines, Custom Log Fields & REFramework Testing

4.1 Building State Machine Projects in Studio 4.2 Logging Levels, Robot Logs & Custom Log Fields in REFramework 4.3 Testing a REFramework Project With and Without Orchestrator Queues

5 Chapter 5: LINQ Queries & DataTable Operations

5.1 LINQ Essentials for Collections & Filtering 5.2 Advanced DataTable Querying with LINQ 5.3 In-Memory DataTable Transformations & Column Operations

6 Chapter 6: Regex, DateTime, JSON & Invoke Activities

6.1 Regular Expressions & Text Parsing for Automation 6.2 DateTime Formatting, Timezone Conversions & TimeSpan Calculations 6.3 JSON Parsing, JSONPath & Serialization with Newtonsoft.Json 6.4 Invoke Method & Invoke Code Activities 6.5 Data Referencing in Invokes: DataTable, List & Dictionary Arguments

7 Chapter 7: Modern UI Automation & Unified Targeting

7.1 Modern Design Experience & The Unified Target Concept 7.2 Anchors, Relative Elements & UI Automation Activities 7.3 Dynamic Selectors, Variables & Wildcards in Selectors

8 Chapter 8: Object Repository, Computer Vision & Remote Runtime

8.1 Object Repository & UI Descriptor Libraries 8.2 AI Computer Vision for Unattended & Remote Interfaces 8.3 Automation in Virtual Environments & UiPath Remote Runtime

9 Chapter 9: Advanced UI Automation: Browser Modes, Agentic UI & macOS

9.1 Browser Automation with the WebDriver Protocol 9.2 Agentic UI Automation: ScreenPlay, Semantic Activities & Healing Agent 9.3 macOS Automation: Native Apps, Office Apps & AppleScript

10 Chapter 10: Advanced Control Flow & Exception Architecture

10.1 Flowcharts, Sequences & Parallel Control Flow Patterns 10.2 Global Exception Handler Architecture & ErrorAction Directives 10.3 TryCatch, Retry Scope & Custom Exception Architectures

11 Chapter 11: Orchestrator Queues & Transaction Management

11.1 Queue Architecture, SpecificContent & Transaction Lifecycles 11.2 Queue Items SLA, Postpone, Deadlines & Priority Scheduling 11.3 Bulk Operations, Transaction Status Updates & Queue Triggers

12 Chapter 12: Orchestrator Tenant & Folder Entities

12.1 Asset Types, Per-Robot Assets & External Credential Stores 12.2 Modern Folder Hierarchy, User/Robot Assignment & Permissions 12.3 Storage Buckets, Webhooks & Environment Promotion 12.4 Orchestrator Tags: Labels, Properties & Governance

13 Chapter 13: Unattended Execution, API Triggers & Cloud Robots

13.1 Unattended Job Execution: Folders, Priorities, Background vs. Foreground & Runtimes 13.2 API Triggers: Starting Jobs from External Systems over HTTP 13.3 Serverless and Cloud VM Robots: Cloud-Hosted Execution Options

14 Chapter 14: Monitoring, Recording & Solutions Management

14.1 Orchestrator Monitoring, Trigger Alerts & Job Health 14.2 Job and Transaction Recording: Troubleshooting Faulted Unattended Jobs 14.3 Solutions Management: Packaging and Deploying Automations with Their Resources

15 Chapter 15: Debugging, Remote Debugging & Profiling

15.1 Studio Debugging Tools: Breakpoints, Panels & Execution Control 15.2 Remote Debugging: Remote Machine and Unattended Robot Connections 15.3 Profile Execution: Finding Performance Bottlenecks in Studio

16 Chapter 16: RPA Testing & Test Suite

16.1 UiPath Test Suite Overview, Test Cases & Given-When-Then Structure 16.2 Data-Driven Testing, Test Verification Activities & Mock Activities 16.3 CI/CD Pipelines with uipcli & Test Manager Traceability

17 Chapter 17: Long-Running Workflows, Action Center & Apps

17.1 Long-Running Workflows: Persistence, Suspend and Resume 17.2 Action Center & Human-in-the-Loop Orchestration 17.3 UiPath Apps: Action Apps, Automations & Integration Service

18 Chapter 18: Trigger-Based Attended Automation & Callouts

18.1 Trigger-Based Attended Automation: Forms, Triggers & Global Variables 18.2 Running Local Triggers & the Event Inspection Tool 18.3 Callouts & Forms for Attended Guidance

19 Chapter 19: UiPath Assistant & Robot Sessions

19.1 UiPath Assistant: Automations, Reminders, Widgets & Configuration 19.2 Robot Session (Picture in Picture): Child Session vs. Virtual Desktop

20 Chapter 20: Autopilot for Developers & Autopilot for Everyone

20.1 Autopilot for Developers: AI Assistance in Studio and Studio Web 20.2 Autopilot for Everyone: Chat, Automations & Clipboard AI

21 Chapter 21: API Automation & Integration Service

21.1 Integration Service: Connectors, Connections & Connector Activities 21.2 API Workflows in Studio Web 21.3 HTTP Requests: Web APIs, the Orchestrator API & Connector Requests 21.4 Connector Builder: Custom Integration Service Connectors 21.5 Integration Service Event Triggers: Connected and Disconnected 21.6 GenAI Activities: Generative AI Inside Workflows

22 Chapter 22: Data Service, Context Grounding & Coded Workflows

22.1 Data Fabric (Data Service) Entities: Modeling Business Data 22.2 Data Fabric Activities and the Platform Connector 22.3 Context Grounding: Retrieval-Augmented Generation with Company Data 22.4 Coded Automations: Structure, Arguments & Invoking Workflows 22.5 Coded Automation Services: Orchestrator, UI Automation, Microsoft 365 & Custom Services

23 Chapter 23: Integrated Scenario Practice

23.1 Integrated Scenario Practice: Designing an End-to-End Solution

13.2 API Triggers: Starting Jobs from External Systems over HTTP

Key Takeaways Explain This Topic AI

API triggers wrap a process in a custom endpoint with a verb (DELETE, GET, POST, PUT) and a tenant-unique slug that defaults to the process name and cannot contain slashes.

Calls are authorized with a personal access token or OAuth; invoking needs Jobs Create and following the result needs Jobs View.

Async polling returns 202 with a status URI, then 303 to the output URI when the job completes.

Fire and forget returns 200 OK only; sync long-polling returns the output in the response and allows jobs of up to 15 minutes.

POST and PUT carry input arguments in a JSON body, GET uses the query string, and a tenant can have at most 1,000 API triggers.

Last updated: September 2026

13.2 API Triggers: Starting Jobs from External Systems over HTTP

Core Concept: An API trigger wraps an existing process in a custom HTTP endpoint. An external application calls that URL to start a job and, depending on the call mode , receives the job's output arguments. API triggers are listed explicitly in the exam description.

Creating an API Trigger

In a folder, go to Automations > Triggers > API Triggers and select Add a new trigger . The form includes:

  • Field What to know
  • Process Name The underlying process that each call starts
  • Name A name to identify the trigger
  • Job Priority Defaults to Inherited (the process priority)
  • Runtime type The runtime used for the jobs the trigger launches
  • Arguments Default values for the process input arguments
  • Verb DELETE , GET , POST , or PUT

Slug Appended to the base URL to form the endpoint. Default ${Process_Name} ; must be unique in the tenant; slashes are not supported

Default call mode Async polling (default), Async fire & forget , or Sync (long-polling)

Further options match other triggers: Schedule ending of job execution (stop, kill, or stop then kill), Generate an alert if the job started and has not completed , and the Execution Target account. A tenant can have at most 1,000 API triggers .

The resulting endpoint has this form: {AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/t/<INVOKE_URL>

Authentication and Permissions

Calls are authorized with a personal access token in the bearer header, or with OAuth .

Triggers permissions (View, Edit, Create, Delete) at folder level govern managing API triggers.

Jobs Create is needed to invoke a trigger, and Jobs View to follow the job until its result is available.

Passing Input Arguments

With POST or PUT , send a JSON body whose keys are the input argument names, for example {"argument1": 123, "argument2": "my string"} .

With GET , place the parameters in the query string and omit the Content-Type header.

The optional $callMode key overrides the default call mode for one call: AsyncRequestReply , FireAndForget , or LongPolling .

  • The Three Call Modes
  • 1. Async polling (default)

The call creates the job and returns 202 Accepted with a status URI in the Location header.

The client polls the status URI.

When the job completes, the status call returns 303 See Other , redirecting to the output URI .

The client follows the output URI to read the job result: its output arguments, or the error.

2. Async fire & forget

The call creates the job and returns 200 OK without further information. Use it when the caller does not need the result, such as a nightly refresh started by a scheduler.

3. Sync (long-polling)

The call creates the job and blocks while the job runs.

If the job completes in time, the same response carries the output arguments .

If a timeout passes first, the response is 303 See Other to the status URI, which blocks again. This can repeat as a redirect loop until the job completes.

The maximum job duration for this mode is 15 minutes .

  • Need Best call mode
  • A web form waits briefly for a short automation's answer Sync (long-polling)
  • A long job whose result must be collected later Async polling
  • Start a job and move on Async fire & forget
  • Designing the Process Behind an API Trigger

Arguments are the contract. Keep input and output argument names stable, because callers depend on them. Output arguments are what the caller receives.

Validate inputs early. Throw a clear exception when required arguments are missing, so the caller gets a meaningful error instead of a half-run job.

Choose the runtime deliberately. Short background processes suit serverless robots, while UI automation needs a foreground-capable machine.

Plan for concurrency. Each call creates a new job, so bursts of calls queue as Pending jobs until runtimes are free.

Worked Example

An intranet page lets employees check their remaining leave. The team:

Builds a background process GetLeaveBalance with input in_EmployeeId and output out_Balance .

Creates an API trigger with verb GET , slug leave-balance , and call mode Sync (long-polling) .

The page calls the endpoint with ?in_EmployeeId=E1024 , and the response contains out_Balance .

If the process sometimes needs more than a few seconds, the page switches to Async polling , shows a spinner, and follows the status URI until the 303 redirect provides the output URI.

API Triggers Versus Other Ways to Start Jobs

  • Mechanism Started by Typical use
  • Time trigger A schedule Daily or hourly batches
  • Queue trigger New items in a queue Transactional workloads
  • Event trigger An Integration Service connector event A file added, a record created in a SaaS app
  • API trigger An HTTP call to a custom URL External apps that need to start a job and often read its result

Orchestrator API StartJobs A general Orchestrator API call Full control, with more setup (folder header, release key)