webhooks de recursos da uip

Gerenciar webhooks do Orchestrator — Retornos de chamada HTTP disparados em eventos de plataforma (conclusão de trabalho, falha de item da fila e assim por diante). Os webhooks têm o escopo de tenant.

Para as convenções entre recursos (autenticação, tipos de chave, envelope de saída), consulte a visão geraluip resource .

Resumo

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

Listar webhooks. Filtros: -n, --name, --enabled, --disabled ( mutuamente exclusivo).

get

Obtenha detalhes do webhook por chave, incluindo eventos assinados e configurações SSL.

Criar

Crie um webhook. Necessário --name, --url. Opcional -d, --description, --events <comma-list> (ignora a assinatura de todos os tipos de eventos), --secret, --allow-insecure-ssl.

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

Atualizar

Atualize por chave. Fornecer --events muda o webhook de assinar todos para a lista fornecida.

Excluir

Exclui um webhook por chave.

Ping

Envie um ping de teste para o URL do webhook para verificar a conectividade.

Tipos de eventos

Liste cada tipo de evento que um webhook pode se inscrever. Use os nomes retornados com create --events ou update --events.

uip resource webhooks event-types

Veja também

• Visão geraluip resource — convenções compartilhadas para cada verbo uip resource .
• Como fazer: gerenciar ativos e filas do Orchestrator — padrões de criação de webhooks.