UiPath Documentation
add-ins
latest
false
  • Getting started
    • Introduction
  • UiPath Add-in for Mulesoft
    • About
    • Setup
    • Installation
    • Configuration
    • Quickstart
  • UiPath Add-in for Microsoft Power Automate
  • UiPath Add-in for Salesforce
  • UiPath Add-in for ServiceNow
  • UiPath Add-in for Workato
  • UiPath Add-in for Workday
UiPath logo, featuring letters U and I in white

Add-ins user guide

Last updated Mar 30, 2026

Quickstart

Introduction

The purpose of this guide is to show you how to use the UiPath Add-in for Mulesoft by performing a Start Job operation.

Start job

To start a job, you must provide at least the following request body input parameters:

ParameterDescription
ReleaseKeyThe ID you get by performing Get Releases. The Orchestrator needs this key to run a specific version of a process.
StrategyFor modern folders we recommend making use of ModernJobsCount.
JobsCountHow often the job is executed.
InputArgumentsIf your job has input parameters, they can be sent as a JSON string in the InputArguments field. If it does not have input parameters, this field is ignored.
Note:

You need the Folder ID to perform the Get Releases operation. This ID is also required in the Start Job operation. To get Folder Id you need to perform the Get Folders operation.

Start Job operation flow in Anypoint Studio

Follow these steps to perform the operation:

  1. In Anypoint Studio, click File, go to New and select Mule Project. Name the project and click Finish.
  2. In the Search field, type HTTP and drag the HTTP Listener to the canvas.
  3. Click the HTTP Listener, then click the green plus sign to the right of Connector Configuration. On the next screen, add the Host and Port, then click OK.
  4. Provide the Path to HTTP Listener with the URI parameter. Example: /job/start}.
  5. In the Responses tab, set the variable http.status with the default 200, as indicated in the image below:

HTTP Listener response tab with http.status variable set to 200

Steps

  1. Provide Connection Configuration Details.
    • On the Mule Palette, search for the Get Folders operation and drag it onto the canvas. Click on the new configuration and provide configuration details as below:

      Get Folders operation connection configuration details

  2. Provide the operation parameters.
    • Enter the $filter parameter value as: DisplayName eq 'UnattendedProcesses'.

      Filter parameter set to DisplayName eq UnattendedProcesses

    • This operation returns the Folder ID. You will use Set Variable to hold the value of Folder ID.

  3. Set Variable.
    • Search Set Variable in the Mule Palette, drag and drop it beside Get Folder.

    • Enter the variable name and value as seen below:

      Set Variable configuration with Folder ID variable name and value

  4. Get Releases.
    • Search Get Releases in the Mule Palette, then drag and drop it beside Set Variable.
    • Enter the folderId, which you set as a variable in the previous step, as UIPATH Organization Unit Id.
    • This operation returns the Release key, which is required in the Start Job operation.
  5. Start Job.
    • Search Start Job in the Mule Palette, then drag and drop it beside Set Variable.

    • Enter the folderId, already set as variable, as UIPATH Organization Unit Id.

    • In the Body parameter, enter a JSON as seen below:

      %dw 2.0
      output application/json
      ---
      {
       "startInfo": {
        "ReleaseKey": payload.value.Key[0],
        "Strategy": "ModernJobsCount",
        "JobsCount": 1,
        "InputArguments": "{}"
       }
      }
      %dw 2.0
      output application/json
      ---
      {
       "startInfo": {
        "ReleaseKey": payload.value.Key[0],
        "Strategy": "ModernJobsCount",
        "JobsCount": 1,
        "InputArguments": "{}"
       }
      }
      
    • For a Successful response, set success payload as indicated below:

      output
      application/json
      ---
      {
      "message":"Operation has been executed successfully",
      "payload": payload
      }
      output
      application/json
      ---
      {
      "message":"Operation has been executed successfully",
      "payload": payload
      }
      

      Start Job success response payload configuration

    • For a Failure response, set http.status as 500, and the error payload as:

      Start Job failure response with http.status set to 500

      output
      application/json
      ---
      {
      "message":"There is an error while performing this operation.",
      "error":error
      }
      output
      application/json
      ---
      {
      "message":"There is an error while performing this operation.",
      "error":error
      }
      

      Complete Start Job flow in Anypoint Studio canvas

  • Introduction
  • Start job
  • Steps

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated