- Overview
- Get started
- Concepts
- Using UiPath CLI
- How-to guides
- CI/CD recipes
- Command reference
- Overview
- Exit codes
- Global options
- uip codedagent
- uip coder
- uip context-grounding
- uip docsai
- uip function
- uip guardrails
- uip llm-configuration
- uip llm-gateway
- uip maestro authoring
- uip maestro registry
- uip model-hub
- activities find
- activities get-default-xaml
- analyze
- analyzer-rules list
- build
- cleanup
- data-fabric-entities install
- data-fabric-entities list
- files diff
- get-library-object-repository
- get-object-repository
- init
- instances list
- pack
- packages inspect
- packages install
- packages versions
- publish
- remote
- restore
- run, debug & execution
- settings
- studio start
- templates search
- test-data add-entity
- test-data add-queue
- test-data add-variation
- tm
- uia
- validate
- workflow-examples get
- workflow-examples list
- uip tasks
- uip traces
- uip traces feedback
- Migration
- Reference & support
uip or webhooks
Syntax and options for `uip or webhooks`, which manages Orchestrator HTTP callbacks fired on platform events.
Manage Orchestrator webhooks — HTTP callbacks fired on platform events (job completion, queue-item failure, and so on). Webhooks are tenant-scoped.
For the cross-resource conventions (auth, key types, output envelope), see the uip or overview.
Synopsis
uip or webhooks list [-n <name>] [--enabled | --disabled] [-l, --limit <n>] [--offset <n>] [--sort-by <field>] [--all-fields]
uip or webhooks get <webhook-key> [--all-fields]
uip or webhooks create <name> --url <url> [-d <desc>] [--events <list>] [--secret <s>] [--allow-insecure-ssl]
uip or webhooks update <webhook-key> [flags as for create] [--enabled | --disabled]
uip or webhooks delete <webhook-key> --yes
uip or webhooks ping <webhook-key>
uip or webhooks event-types
uip or webhooks list [-n <name>] [--enabled | --disabled] [-l, --limit <n>] [--offset <n>] [--sort-by <field>] [--all-fields]
uip or webhooks get <webhook-key> [--all-fields]
uip or webhooks create <name> --url <url> [-d <desc>] [--events <list>] [--secret <s>] [--allow-insecure-ssl]
uip or webhooks update <webhook-key> [flags as for create] [--enabled | --disabled]
uip or webhooks delete <webhook-key> --yes
uip or webhooks ping <webhook-key>
uip or webhooks event-types
list
List webhooks. Filters: -n, --name, --enabled, --disabled (mutually exclusive). --sort-by <field> sorts results (default Id desc); --all-fields returns the full API response.
get
Get webhook details by key, including subscribed events and SSL settings. --all-fields returns the full API response.
create
Create a webhook. Requires <name> and --url. Optional -d, --description, --events <comma-list> (omit to subscribe to all event types), --secret, --allow-insecure-ssl.
uip or webhooks create JobAlerts \
--url https://hooks.example.com/uipath \
--events "job.completed,job.faulted"
uip or webhooks create JobAlerts \
--url https://hooks.example.com/uipath \
--events "job.completed,job.faulted"
update
Update by key. Providing --events switches the webhook from subscribe-to-all to the given list. Pass --enabled or --disabled to toggle the webhook's state (mutually exclusive).
uip or webhooks update <webhook-key> --disabled
uip or webhooks update <webhook-key> --disabled
delete
Delete a webhook by key. Requires -y, --yes — the CLI never prompts for destructive operations.
uip or webhooks delete <webhook-key> --yes
uip or webhooks delete <webhook-key> --yes
ping
Send a test ping to the webhook URL to verify connectivity. Delivery is asynchronous — a successful response means the ping was queued, not that the endpoint received it; confirm receipt on the endpoint itself.
event-types
List every event type a webhook can subscribe to. Use the returned names with create --events or update --events.
uip or webhooks event-types
uip or webhooks event-types
Exit codes
See Exit codes for the shared contract. delete exits 1 if -y, --yes is omitted.
See also
uip oroverview — shared conventions for everyuip orverb.- How-to: manage Orchestrator assets and queues — webhook creation patterns.