UiPath Documentation
uipath-cli
latest
false
UiPath CLI user guide

uip or triggers

Syntax and options for `uip or triggers`, which manages time, queue, and API triggers in Orchestrator.

Manage Orchestrator triggers: time (schedule), queue, and API. All trigger types are folder-scoped. Every verb except history accepts --type <time|queue|api> (default time).

For the cross-resource conventions (auth, folder scoping, key types, output envelope), see the uip or overview.

Synopsis​

uip or triggers list     [--type <type>] --folder-path <path> | --folder-key <key> [-n <name>] [--enabled | --disabled] [-l <n>] [--offset <n>] [--sort-by <field>] [--all-fields]
uip or triggers get      <trigger-key> [--type <type>] --folder-path <path> | --folder-key <key> [--all-fields]
uip or triggers create   [--type <type>] --name <n> --release-key <k> --runtime-type <r> [--job-priority <p>] [--folder-path <path> | --folder-key <key>] [type-specific flags]
uip or triggers update   <trigger-key> [--type <type>] --folder-path <path> | --folder-key <key> [type-specific flags] [--enabled | --disabled]
uip or triggers delete   <trigger-key> [--type <type>] --folder-path <path> | --folder-key <key> --yes
uip or triggers history  <trigger-key> --folder-path <path> | --folder-key <key> [-l <n>] [--offset <n>] [--sort-by <field>] [--all-fields]
uip or triggers list     [--type <type>] --folder-path <path> | --folder-key <key> [-n <name>] [--enabled | --disabled] [-l <n>] [--offset <n>] [--sort-by <field>] [--all-fields]
uip or triggers get      <trigger-key> [--type <type>] --folder-path <path> | --folder-key <key> [--all-fields]
uip or triggers create   [--type <type>] --name <n> --release-key <k> --runtime-type <r> [--job-priority <p>] [--folder-path <path> | --folder-key <key>] [type-specific flags]
uip or triggers update   <trigger-key> [--type <type>] --folder-path <path> | --folder-key <key> [type-specific flags] [--enabled | --disabled]
uip or triggers delete   <trigger-key> [--type <type>] --folder-path <path> | --folder-key <key> --yes
uip or triggers history  <trigger-key> --folder-path <path> | --folder-key <key> [-l <n>] [--offset <n>] [--sort-by <field>] [--all-fields]
Note:

There is no dedicated enable or disable command. Toggle a trigger with update <trigger-key> --enabled or update <trigger-key> --disabled instead (the two flags are mutually exclusive).

List triggers of one type in a folder. Requires --folder-path or --folder-key. Filters: -n, --name (contains-match), --enabled, --disabled (mutually exclusive). Paginated via -l, --limit (default 50) / --offset. --sort-by <field> sorts results (default Id desc). --all-fields returns the full API response instead of the curated subset.

uip or triggers list --type time --folder-path Shared --enabled
uip or triggers list --type time --folder-path Shared --enabled

Get a trigger by key. Requires --folder-path or --folder-key. --all-fields returns the full API response instead of the curated subset.

create​

Create a trigger. Required flags: --name, --release-key, --runtime-type <Serverless|Unattended|Headless|NonProduction|AgentService>. --job-priority <Low|Normal|High> defaults to Normal. Pass --disabled to create the trigger in a disabled state (default: enabled).

The folder is inferred from --release-key. Pass --folder-path or --folder-key when your identity has a folder-level role only (such as an external app), because such an identity cannot look processes up tenant-wide.

Type-specific:

  • time needs --cron (Quartz 6-field format) and optionally --time-zone.
  • queue needs --queue-key (and accepts --items-threshold, --max-jobs, --items-per-job — each default 1 — and --activate-on-complete).
  • api needs --slug and --method <Get|Post|Put|Delete> (with optional --calling-mode <AsyncRequestReply|AsyncCallback|LongPolling|FireAndForget>).

Common: -d, --description, --input-arguments <json>, --calendar-key, --stop-strategy <SoftStop|Kill>, --kill-process-expression, --resume-on-same-context, --run-as-me, repeatable --target "machine=<guid>,user=<guid>,session=<int>", --mapping-mode <dynamic|strict> (default dynamic; use strict when the folder has "Enable account-machine mappings" turned on).

uip or triggers create --type time \
  --name NightlyInvoices --release-key <release-guid> \
  --runtime-type Unattended --job-priority Normal \
  --folder-path Shared --cron "0 0 2 * * ?" --time-zone UTC
uip or triggers create --type time \
  --name NightlyInvoices --release-key <release-guid> \
  --runtime-type Unattended --job-priority Normal \
  --folder-path Shared --cron "0 0 2 * * ?" --time-zone UTC

update​

Update by key. Requires --folder-path or --folder-key. Only the fields you provide change. Accepts --name, --release-key, --runtime-type, --job-priority, --target, --mapping-mode, and the type-specific flags of create, all optional. -d, --description, --input-arguments, --calendar-key, --stop-strategy, and --kill-process-expression are create-only. Use --no-* counterparts to unset booleans (for example --no-activate-on-complete, --no-resume-on-same-context, --no-run-as-me). Pass --enabled or --disabled to toggle the trigger's state (mutually exclusive).

uip or triggers update <trigger-key> --type time --folder-path Shared --disabled
uip or triggers update <trigger-key> --type time --folder-path Shared --disabled

delete​

Delete a trigger by key. Requires --folder-path or --folder-key, and -y, --yes — the CLI never prompts for destructive operations.

uip or triggers delete <trigger-key> --type time --folder-path Shared --yes
uip or triggers delete <trigger-key> --type time --folder-path Shared --yes

history​

Show the failed fire attempts of a trigger (fire log): why the trigger failed to fire, for example a missing license, no machines, or a disabled trigger. Works for time, queue, API, and Integration Service event triggers; the trigger type is detected from the key, so history takes no --type flag. Requires --folder-path or --folder-key. Paginated via -l, --limit (default 50) / --offset. --sort-by <field> sorts results (default TimeStamp desc). --all-fields returns the full API response instead of the curated subset.

An empty Data array means the trigger has no recorded fire failures, not that it never ran. Use uip or jobs list to see the jobs a trigger started.

If the key does not match a trigger in the folder, the command fails with ErrorCode: "not_found" and exits 1.

uip or triggers history a1b2c3d4-0000-0000-0000-000000000001 --folder-path Shared --limit 2
uip or triggers history a1b2c3d4-0000-0000-0000-000000000001 --folder-path Shared --limit 2
{
  "Code": "TriggerHistory",
  "Data": [
    {
      "TimeStamp": "2026-01-15T12:00:00.000Z",
      "EventType": "NoMachineAssociatedWithFolder",
      "Level": "Error",
      "Message": "No machines available",
      "TriggerKey": "a1b2c3d4-0000-0000-0000-000000000001"
    }
  ]
}
{
  "Code": "TriggerHistory",
  "Data": [
    {
      "TimeStamp": "2026-01-15T12:00:00.000Z",
      "EventType": "NoMachineAssociatedWithFolder",
      "Level": "Error",
      "Message": "No machines available",
      "TriggerKey": "a1b2c3d4-0000-0000-0000-000000000001"
    }
  ]
}

Exit codes​

Refer to Exit codes for the shared contract. delete exits 1 if -y, --yes is omitted. Every verb that requires a folder exits 1 when neither --folder-path nor --folder-key is provided. history exits 1 with ErrorCode: "not_found" when the key does not match a trigger.

See also​

Was this page helpful?

Connect

Need help? Support(opens in new window)

Want to learn? UiPath Academy(opens in new window)

Have questions? UiPath Forum(opens in new window)

Stay updated