uip ou webhooks

Sintaxe e opções para "uip ou webhooks", que gerencia retornos de chamada HTTP do Orchestrator disparados em eventos da plataforma.

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

Resumo

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

Listar webhooks. Filtros: -n, --name, --enabled, --disabled ( mutuamente exclusivo ). --sort-by <field> classifica resultados (padrão Id desc); --all-fields retorna a resposta completa da API.

get

Obtenha detalhes do webhook por chave, incluindo eventos assinados e configurações SSL. --all-fields retorna a resposta completa da API.

Criar

Crie um webhook. Requer <name> e --url. Opcional -d, --description, --events <comma-list> (ignorar para assinar todos os tipos de eventos), --secret, --allow-insecure-ssl.

uip or webhooks create 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. Passe --enabled ou --disabled para alternar o estado do webhook ( mutuamente exclusivo ).

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

Excluir

Exclui um webhook por chave. Requer -y, --yes — a CLI nunca solicita operações destrutivas.

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

Ping

Envie um ping de teste para o URL do webhook para verificar a conectividade. A entrega é assíncrona — uma resposta bem-sucedida significa que o ping foi colocado na fila, não que o ponto de extremidade o recebeu; confirmar o recebimento no próprio ponto de extremidade.

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 or webhooks event-types

Códigos de saída

Consulte Códigos de saída para o contrato compartilhado. delete sai de 1 se -y, --yes for omitido.

Veja também

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