uip o webhooks

Sintaxis y opciones para `uip o webhooks`, que gestiona las devoluciones de llamada HTTP de Orchestrator activadas en eventos de plataforma.

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

Enumerar webhooks. Filtros: -n, --name, --enabled, --disabled (mutuamente excluyentes). --sort-by <field> ordena los resultados (predeterminado: Id desc); --all-fields devuelve la respuesta completa de la API.

get

Obtén detalles del webhook por clave, incluidos los eventos suscritos y la configuración de SSL. --all-fields devuelve la respuesta completa de la API.

Crear

Crea un webhook. Requiere <name> y --url. Opcional -d, --description, --events <comma-list> (omitir para suscribirse a todos los tipos de eventos), --secret, --allow-insecure-ssl.

uip or webhooks create JobAlerts \
  --url https://hooks.example.com/uipath \
  --events "job.completed,job.faulted"

Actualizar

Actualizar por clave. Proporcionar --events cambia el webhook de suscribirse a todos a la lista dada. Pasa --enabled o --disabled para alternar el estado del webhook (mutuamente excluyentes).

uip or webhooks update <webhook-key> --disabled

Eliminar

Eliminar un webhook por clave. Requiere -y, --yes: la CLI nunca solicita operaciones destructivas.

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

Hacer ping

Envía un ping de prueba a la URL del webhook para verificar la conectividad. La entrega es asíncrona: una respuesta correcta significa que el ping se puso en cola, no que el punto final lo recibió; confirmar la recepción en el propio punto final.

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

Consulta Códigos de salida para el contrato compartido. delete sale de 1 si se omite -y, --yes.

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.