UiPath Documentation
marketplace
latest
false
UiPath logo, featuring letters U and I in white

Marketplace user guide

Last updated Apr 1, 2026

Start job

UiPath.Upwire.Activities.StartJob

The StartJob activity starts an existing Upwire job that runs your specified flow template (TemplateID) and then outputs the ID of the started job (JobID).

Summary

Dependencies

DependencyDetails
PackagesUiPath.Upwire.Activities
ActivitiesUpwire Scope

Attributes

AttributesDetails
Inputs (Variables)String Applies to property: TemplateId
Outputs (Variables)String Applies to property: JobId
ExamplesQuickstart

Properties

The values for the following properties are specified when adding this activity to your project in UiPath Studio.

StartJob activity properties panel in UiPath Studio

Common

DisplayName

The display name of the activity.

AttributesDetails
TypeString
RequiredYes
Default valueStart Job
Allowed valuesEnter a String or String variable.
NotesN/A

Input

TemplateId

The template ID of the flow that you want to start.

Attributes

Details

Type

String

Required

Yes

Default value

Empty

Allowed values

Enter a String or String variable.

Notes

  • The template ID can be found by opening the flow that you want to run and going to the About this Template option in the menu (see image below).

    * You can also see the template ID in the flow URL.

  • In order to start your job using the Start Job activity, you must set your template to wait for an API call. For more information, see the Setup page in this guide.

Upwire flow template About this Template menu showing the template ID

Misc

Private

If selected, the values of variables and arguments are no longer logged at Verbose level.

AttributesDetails
TypeCheckbox
RequiredNo
Default valueNot Selected
Allowed valuesSelected or Not Selected
NotesN/A

Options

Data

The collection of variables and values that you want to use in your flow template when the job runs

AttributesDetails
TypeCollection
RequiredNo
Default valueEmpty
Allowed valuesEnter the variable names that you set when creating your flow template. * Your variable names can be found by opening the flow that you want to run and going to the Edit Template Data option in the menu (see example image below).
NotesThe variable names that you enter for your Collection data must match the names you set in the template (see example image below).

Upwire flow template Edit Template Data menu showing variable names

StartJob activity Data collection property with matching template variable names

Output

JobID

The ID of the running job.

AttributesDetails
TypeString
RequiredNo (recommended if you plan to use the output data in subsequent activities)
Default valueEmpty
Allowed valuesEnter a String variable.
NotesYou can use the JobID variable in a subsequent Stop Job activity.
  • Summary
  • Dependencies
  • Attributes
  • Properties
  • Common
  • Input
  • Misc
  • Options
  • Output

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated