Subscribe

UiPath Integrations

The UiPath Integration Service Guide

Overview

Triggers provide a uniform mechanism for subscribing to events from the Connector platforms. It gives you the flexibility to automatically start automations or processes in Orchestrator

Prerequisites

Before you can configure Triggers, make sure the following conditions are met:

  • The Integrations Service is enabled and provisioned for your tenant.
  • The Triggers tab is displayed in the Integrations window.
  • You have already setup an Unattended or Non-production Robot in your Orchestrator instance
  • You are using Studio & Robot version 21.10 or higher

Using Triggers in the Integration Service

Create your process

Create your process in UiPath Studio as you would normally do. Using the Integration Service, any automation can be triggered for any process,

To receive the details of a record, you can also follow the indications below:

  • If you want to know the actual Connector, Event, Record Type or Record that triggered the process in your workflow, you can define the following input arguments of type String in your process.
    Integration Service will populate them automatically when it starts the job.
    • UiPathEventConnector
    • UiPathEvent
    • UiPathEventObjectType
    • UiPathEventObjectId

📘

Note

Find out more about how Arguments work and how to manage them here.

  • To retrieve and work with a record that has a trigger on a job run, use the UiPathEventObjectId input argument to retrieve the record from the source system.

Here is an example of how the input argument values are passed by Integration Service.

Publish your process

Publish your process to Orchestrator to as you would normally do. You can publish it to a shared folder or a personal workspace. Make sure to create a process out of your package.

Configure your trigger

To add a Trigger, you will have to:

  1. Access the Automation Cloud.

  2. On the left-side menu, click on Integrations. The Integrations windows includes three separate tabs: Connectors, Connections and Triggers.

  3. Access the Triggers tab and click on the Add Trigger button.

  4. Select the desired Connector and Connection from their respective dropdown menus. If there is only one connection configured for that particular connector, it will be selected automatically.

  5. Select the desired Event and Record Type from their respective dropdown menus.

📘

Note

Event types may vary with the connector.

  1. On the right, select the Process that you want to run and the respective Job Type.

  2. Click the Add Trigger button to create your trigger and activate it.

Alternatively, you can create a new trigger from the Connections tab. To do that, you will have to:

  1. Click on a connection's “More Actions” button.

  2. Select the Add trigger option.

  3. Select the desired Event and Record Type from their respective dropdown menus. In this case, the Connector and Connection are already selected and cannot be changed.

  4. On the right, select the Process that you want to run and the respective Job Type.

  5. Click the Add Trigger button to create your trigger and activate it.

📘

Note

Event monitoring is currently set to poll every 5 minutes. As such, it could take up to 5 minutes before the associated process starts.

You can see a job's details under the Jobs tab in your Orchestrator Folder. A job started from Integration service will show its source as Integration Trigger.

Other Trigger features

Delete trigger

Go to the Triggers tab in the Integrations window. Click the More Actions button corresponding to your trigger and select Delete.

Trigger details view

Simply click on a trigger to view its details

Activate/Deactivate a trigger**

To activate or deactivate a trigger, you will first have to click on it to view its details. Then click the switch located in the upper-left side of the window.

Automatically disabling a trigger upon failure

A trigger is disabled and set to error state if you are not able to start the job after 11 attempts (~34 hours) for a single event or if the job does not start for the last 100 events.

The 10 retries for every event are done with an exponential back-off strategy. Each subsequent retry attempt comes after a delay twice as long as the previous attempt.

Updated about a month ago

Triggers


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.