About the Workato activity package

Overview

Workato helps you automate business workflows across cloud apps, on-premise apps, and employees. By combining an enterprise-grade platform with easy to use functionality, Workato enables users to quickly build workflow automations.

The Workato activities give you the ability to automate interactions with your existing Workato recipes. Using the Workato APIs, this activities package enables your robot to get, list, start, and stop recipes.

If you're ready to start using the Workato activities, see the Get Started section below. To learn more about the package, keep reading to see How it works and the Technical References.

Note: Please refer to the Product lifecycle page for UiPath Studio version compatibility and support.

How it works

To enable the outbound automation between UiPath and Workato, the activities establish an authenticated connection to the Workato API via the Workato Scope activity.

After the connection is established, the other Workato activities send requests to the applicable Workat API operation(s) using the parameters you enter in the activities' input properties. If the requests are successful, the activities return the response values to the output property variables.

How does it connect?

Before the scope activity can be used to establish a connection, you must complete the steps outlined in the Setup guide. After you complete the Setup steps, you can begin building your automation projects

Each Workato activity calls a Workato API using the request parameters you enter in the activity's input properties. If the call is successful, the activity returns the relevant values to your output property variables for use in other activities.

To successfully call the Workato APIs, activities include an authorization header in each request. The authorization header contains the user email and access token (auth-token, also referred to as the API key) the Workato server uses to validate the identity of the client making the request.

To include a valid authorization header, the activities rely on the Workato Scope activity to provide user email and auth-token values. When you build your automation project, you first add the Workato Scope activity and enter values for the authentication properties (email, environment, auth-token).

After adding the scope activity, you add other activities inside of it. When you run your project, the activities collect the values that you enter in the scope authentication properties and send requests to the applicable Workato APIs.

Note:

The Workato activities can only send requests to Workato REST API endpoints.

The Workato activities can not send requests to callable recipe REST endpoints (configured using the the Workato API Platform) . If you're interested in automating calls to these endpoints, you could use the generic HTTP Request activity.

Technical References

For a complete list of the Workato REST API used by each activity and links to the relevant API documentation, see the Technical References page.

You don't need to be familiar with the Workato REST APIs to use the activities. The Technical References are for informational purposes only.

Get Started

Before you build your first project, complete the steps in the Setup guide.

To learn more about the Workato activities (including example property inputs/outputs), see the Activities page for a complete list of activities and links to the detail pages.