> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# UiPath Webhook Setup Guide

> Configure UiPath to deliver events to StackOne.

## Prerequisites

The connector should already be set up, with a Connector Profile and a Linked Account. See [Getting Started](https://docs.stackone.com/connectors/uipath.md#getting-started) on the UiPath connector page.

## How webhooks are set up

StackOne creates and manages the Orchestrator webhook automatically when the account is connected, and removes it when the account is disconnected. There is no URL to paste in Orchestrator. The webhook belongs to the tenant in the **Tenant Name** field and covers every folder in it.

<ul>
  <li>StackOne creates one tenant webhook named `StackOne`, subscribed to the events you enable in StackOne.</li>
  <li>Changing the enabled events in StackOne replaces the webhook with a new one.</li>
  <li>The **Native Webhook URL** on the linked account is the address StackOne registers. You don't need to copy it.</li>
</ul>

## Grant the webhooks scope

The external application the account uses needs the `OR.Webhooks` application scope, so StackOne can create and delete the webhook.

**1. Open the external application**

Sign in to your [UiPath Automation Cloud account](https://cloud.uipath.com) as an Organization Administrator, open **Admin** and select **External applications**.

<ul>
  <li>On the **OAuth apps** tab, click **Edit** on the application the account uses.</li>
</ul>

![The External applications OAuth apps tab with the Edit button of the application highlighted](https://mintcdn.com/stackone-60/GEh2bYvJkg5Tlo0c/connectors/uipath/images/events-external-applications.png?fit=max\&auto=format\&n=GEh2bYvJkg5Tlo0c\&q=85\&s=8a4cbaf8ea7c1275d60a09f5807fcba2)

**2. Edit the Orchestrator resource**

Under **Resources**, click **Edit** on the **Orchestrator** row. The **Edit resource** panel opens.

![The Edit application page with the Edit button of the Orchestrator resource highlighted](https://mintcdn.com/stackone-60/GEh2bYvJkg5Tlo0c/connectors/uipath/images/events-orchestrator-resource.png?fit=max\&auto=format\&n=GEh2bYvJkg5Tlo0c\&q=85\&s=42e45a57bbd28d9baf715cccb3810c8d)

**3. Add the OR.Webhooks scope**

Open the **Application scope(s)** tab and type `OR.Webhooks` in **Search**.

<ul>
  <li>Tick **OR.Webhooks**, the entry with no `.Read` or `.Write` ending.</li>
  <li>Click **Save** in the panel, then click **Save** on the application page.</li>
</ul>

![The Edit resource panel on the Application scope(s) tab with the OR.Webhooks scope ticked and highlighted](https://mintcdn.com/stackone-60/GEh2bYvJkg5Tlo0c/connectors/uipath/images/events-webhooks-scope.png?fit=max\&auto=format\&n=GEh2bYvJkg5Tlo0c\&q=85\&s=2c85df123a9182814427072024e3b0d3)

**4. Add the scope to the account**

Edit the account in StackOne Hub and add `OR.Webhooks` to the end of its **Scopes** field, separated by a space.

<ul>
  <li>Example: `PM.Group.Read PM.RobotAccount.Read PM.User.Read OR.Folders.Read OR.Execution.Read OR.Jobs OR.Queues OR.Assets OR.Robots.Read OR.Machines.Read OR.Monitoring.Read OR.Tasks OR.Webhooks`</li>
  <li>Save the account, then enable the events you want.</li>
</ul>

## Available webhook events

The following Orchestrator events can be enabled. Only events selected in StackOne are included in the webhook, so Orchestrator does not deliver events that are not selected.

**1. Review job and trigger events**

Events about jobs in any folder of the tenant, and about time triggers that fail to start one.

<ul>
  <li>**Job Created** (`job.created`) — Fired when one or more jobs are created, manually, by a trigger or through the API.</li>
  <li>**Job Started** (`job.started`) — Fired when a job starts running on a robot.</li>
  <li>**Job Completed** (`job.completed`) — Fired when a job finishes successfully.</li>
  <li>**Job Faulted** (`job.faulted`) — Fired when a job finishes with an error.</li>
  <li>**Job Stopped** (`job.stopped`) — Fired when one or more jobs are stopped or killed.</li>
  <li>**Job Suspended** (`job.suspended`) — Fired when a long-running job is suspended to wait for an action or a resume trigger.</li>
  <li>**Schedule Failed** (`schedule.failed`) — Fired when a time trigger fails to start its job. The payload gives the reason.</li>
</ul>

**2. Review process events**

Events about processes deployed in folders.

<ul>
  <li>**Process Created** (`process.created`) — Fired when a process is created.</li>
  <li>**Process Updated** (`process.updated`) — Fired when a process changes, such as a new package version.</li>
  <li>**Process Deleted** (`process.deleted`) — Fired when a process is deleted.</li>
</ul>

**3. Review queue and queue item events**

Events about queues and the transactions robots process from them.

<ul>
  <li>**Queue Created** (`queue.created`) — Fired when a queue is created.</li>
  <li>**Queue Updated** (`queue.updated`) — Fired when a queue changes.</li>
  <li>**Queue Deleted** (`queue.deleted`) — Fired when a queue is deleted.</li>
  <li>**Queue Item Added** (`queueItem.added`) — Fired when items are added to a queue.</li>
  <li>**Queue Item Transaction Started** (`queueItem.transactionStarted`) — Fired when a robot starts processing a queue item.</li>
  <li>**Queue Item Transaction Completed** (`queueItem.transactionCompleted`) — Fired when a queue item transaction completes successfully.</li>
  <li>**Queue Item Transaction Failed** (`queueItem.transactionFailed`) — Fired when a queue item transaction fails with a business or application exception.</li>
  <li>**Queue Item Transaction Abandoned** (`queueItem.transactionAbandoned`) — Fired when a queue item is abandoned after 24 hours in progress.</li>
  <li>**Queue Item Retried** (`queueItem.retried`) — Fired when a queue item is retried after a failed attempt.</li>
</ul>

**4. Review robot and machine events**

Events about robots and the state of robot and machine sessions.

<ul>
  <li>**Robot Created** (`robot.created`) — Fired when a robot is created.</li>
  <li>**Robot Updated** (`robot.updated`) — Fired when a robot changes.</li>
  <li>**Robot Deleted** (`robot.deleted`) — Fired when a robot is deleted.</li>
  <li>**Robot Status Changed** (`robot.status`) — Fired when a robot session becomes available, busy, disconnected or unresponsive.</li>
  <li>**Machine Session Status Changed** (`machineSession.status`) — Fired when a machine session changes state.</li>
</ul>

**5. Review Action Center task events**

Events about Action Center tasks.

<ul>
  <li>**Task Created** (`task.created`) — Fired when a task is created by a workflow or through the API.</li>
  <li>**Task Updated** (`task.updated`) — Fired when a task changes.</li>
  <li>**Task Assignment Changed** (`task.assignmentChanged`) — Fired when a task assignee is added, changed or removed.</li>
  <li>**Task Forwarded** (`task.forwarded`) — Fired when a task is forwarded to another user.</li>
  <li>**Task Saved** (`task.saved`) — Fired when a task is saved before it is completed.</li>
  <li>**Task Completed** (`task.completed`) — Fired when a task is completed.</li>
  <li>**Task Deleted** (`task.deleted`) — Fired when a task is deleted.</li>
</ul>

## Delivery format

Details of how Orchestrator delivers events to StackOne.

<ul>
  <li>Each request carries one event. Events that cover several records, such as **Job Created** or **Queue Item Added**, list them in one payload.</li>
  <li>Each request is signed with HMAC-SHA256 in the `X-UiPath-Signature` header, using the secret StackOne sets on the webhook.</li>
  <li>Orchestrator does not retry a failed delivery. After repeated failures it stops sending to the webhook for one hour.</li>
</ul>

## Verify

Your Connector should now be able to receive and process events. Try triggering an event and you should see an Event appear in the Connector logs.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.