UiPath Documentation
activities
latest
false
Productivity activities

Invoke Apple Shortcut

Invoke Apple Shortcut activity that invokes an Apple shortcut and returns its output.

UiPath.AppleScripting.Activities.InvokeAppleShortcut

Description​

Invokes an Apple shortcut and returns its output.

This activity runs an Apple Shortcut by name and returns the result. Apple Shortcuts are automation workflows created in the Shortcuts app on macOS. The activity supports various input types including text, files, or a dictionary of arguments. You can specify output options such as the output path and output type (UTI format). The activity includes timeout configuration and error handling options.

Note:

This package only runs on macOS systems.

Project compatibility​

Windows | Cross-platform

Configuration​

You can configure the activity and its properties as follows:

  • Shortcut name - The name of the shortcut to run.
  • Input arguments - A dictionary of key-value pairs to pass as input to the shortcut.
  • Input text - Plain text input to pass to the shortcut.
  • Input files - An enumerable of file paths to pass as input to the shortcut. Multiple files can be provided.
    Note:

    Input arguments, Input text, and Input files are mutually exclusive — use the plus-menu options (Use Input Arguments, Use Input Text, Use Input Files) to switch between them. For more details on the plus menu options, check Designing automations.

Properties panel​

  • Output path - Optional path where the shortcut output will be written to a file.
  • Output type - Optional Uniform Type Identifier (UTI) for the output format, for example, public.jpeg, public.plain-text.
  • Throw on fail - If set to True, throws an exception when the exit code of the shortcut is not 0. The message contained in the exception will be the content of the standard error stream. By default, this option is set to True.
  • Timeout (milliseconds) - Specifies the amount of time (milliseconds) to wait for the activity to run before throwing an error. Leave blank to wait indefinitely.
  • Result - The result of the shortcut invocation.
  • Description​
  • Project compatibility​
  • Configuration​
  • Properties panel​

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated