UiPath Integrations

Development Guidelines

Base standards for developing custom activities as a UiPath Technology Partner

For more information related to the process of integrating with UiPath, please access the FAQ at this link.

With respect to development guidelines, please find below the standards for creating a custom activity for the UiPath platform. For reference, the current UiPath integrations are accessible here.

1. Dependencies

  • Must be referenced in the Dependencies section of the NuGet package. This can be easily done in Nuget Package Explorer or in the packages.config file. In order to keep package sizes to a minimum, do not include dependency DLLs within the package itself unless necessary.
Nuget Package Explorer

Nuget Package Explorer

packages.config file

packages.config file

  • Use exact package versions (i.e. 1.0.6 not >1.0.6)

2. Icons

  • The package must have an icon.
    This may be done via Nuget Package Explorer or directly in the .nuspec file.
  • Each activity must have an icon.
    See here for instructions on adding icons to your activities.

3. License

  • The package must contain a license and require acceptance of that license. Apache 2.0 is the default and can be found here.
    This may be done in Nuget Package Explorer or directly in the .nuspec file.
Nuget Package Explorer

Nuget Package Explorer

.nuspec file

.nuspec file

4. Descriptions

  • A summary description must be added to the package, either through Nuget Package Explorer or directly in the .nuspec file.
Nuget Package Explorer

Nuget Package Explorer

.nuspec file

.nuspec file

  • Each activity in the package must have a summary description. This may be added in the DesignerMetadata.cs file. See here for instructions on how to do so.
Designer Metadata file

Designer Metadata file

  • Each property / argument within an activity must have a description.
  • Descriptions on the fields of custom classes are useful as well, but not required.

5. Naming

  • Scopes should include the company or product name (e.g. Use UiPath Scope instead of Application Scope).
  • Package Category will be Company Name>Product Name>Feature Name (e.g. UiPath>Studio>Click).

6. Miscellaneous

  • The stable version of UiPath Studio at the time of release must be supported.
  • Internationalization is preferred, but not required.

Updated 2 days ago


Development Guidelines


Base standards for developing custom activities as a UiPath Technology Partner

Suggested Edits are limited on API Reference Pages

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