Skip to main content

uip resource webhooks

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 resource overview.

Synopsis​

uip resource webhooks list         [-n <name>] [--enabled | --disabled]
uip resource webhooks get          <webhook-key>
uip resource webhooks create       --name <n> --url <url> [-d <desc>] [--events <list>] [--secret <s>] [--allow-insecure-ssl]
uip resource webhooks update       <webhook-key> [flags as for create]
uip resource webhooks delete       <webhook-key>
uip resource webhooks ping         <webhook-key>
uip resource webhooks event-types

list​

List webhooks. Filters: -n, --name, --enabled, --disabled (mutually exclusive).

get​

Get webhook details by key, including subscribed events and SSL settings.

create​

Create a webhook. Required --name, --url. Optional -d, --description, --events <comma-list> (omit to subscribe to all event types), --secret, --allow-insecure-ssl.

uip resource webhooks create --name 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.

delete​

Delete a webhook by key.

ping​

Send a test ping to the webhook URL to verify connectivity.

event-types​

List every event type a webhook can subscribe to. Use the returned names with create --events or update --events.

uip resource webhooks event-types

See also​