Setup

Introduction

To successfully establish a connection and send requests to the Workato API, the Workato Scope activity must provide authentication credentials.

To provide the Workato Scope activity with the authentication credentials and enable the other activities to successfully send requests to the Workato API operations, you must complete the Prerequisites and following steps:

1. Get API key

2. Build your project

   
   

   

   
   

Prerequisites

• Workato account

  • Your account email is required in the scope activity.

• Workato environment

  • The instance (preview.workato.com or public.workato.com) that contains the recipes you want to interact with.
  • Selecting the environment is required in the scope activity.

• Workato recipe

  • The Workato activities automate interactions with your recipes. To enable the activities to call the recipes via the Workato API, you must have at least one recipe.

Steps

1. Get API key

The authorization header required for the API requests contains the user email and access token (i.e., auth-token or API key).

To get the API key, go to your Workato Account Settings > API key. You'll enter this value in the UserToken property of the Workato Scope activity.

2. Build your project

1. Create a new automation project.

   1. Open UiPath Studio.
   2. Under New Project, click Process (this opens a New Blank Process window).
   3. Enter a project Name, Location, and Description.

   4. Click Create.

      
      

      

      
      

2. Install the UiPath.Workato.Activities package.

   1. In the Design ribbon, click Manage Packages (this opens the Manage Packages window).
   2. Under All Packages, click Go.
   3. In the Search bar, enter Workato.

   4. Click install and accept the license(s).

      • For more information about Uipath Studio packages, see Managing Packages in the Studio Guide.

        
        

        

        
        

You're done!

Now that you have completed the setup, you can start adding the Workato activities to your project.

Next steps

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.