uip or webhooks

Syntax and options for `uip or webhooks`, which manages Orchestrator HTTP callbacks fired on platform events.

Gestionar webhooks de Orchestrator: devoluciones de llamada HTTP activadas en eventos de plataforma (finalización de trabajos, fallo de artículo en cola, etc.). Los webhooks tienen ámbito de tenant.

Para las convenciones de recursos cruzados (autenticación, tipos de clave, sobre de salida), consulta la descripción general deuip or .

Sinopsis

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

Lista

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.

Crear

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"

Actualizar

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

Eliminar

Delete a webhook by key. Requires -y, --yes — the CLI never prompts for destructive operations.

uip or webhooks delete <webhook-key> --yes

Hacer 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.

tipos de eventos

Enumera cada tipo de evento al que puede suscribirse un webhook. Utiliza los nombres devueltos con create --events o update --events.

uip or webhooks event-types

Códigos de salida

See Exit codes for the shared contract. delete exits 1 if -y, --yes is omitted.

Ver también

• Información generaluip or : convenciones compartidas para cada verbo uip or .
• Tutorial: gestionar activos y colas de Orchestrator : patrones de creación de webhooks.