UIP リソース Webhook

Orchestrator Webhook の管理 — プラットフォーム イベント (ジョブの完了、キュー アイテムの失敗など) で発生する HTTP コールバック。Webhook はテナントスコープです。

リソース間の規則 (認証、キーの種類、出力エンベロープ) については、 uip resource の概要を参照してください。

概要

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)

Webhook を一覧表示します。フィルター: -n, --name、 --enabled、 --disabled (相互に排他的)

get

登録済みのイベントや SSL 設定など、Webhook の詳細をキーごとに取得します。

作成

Webhook を作成します。必須 --name、--url任意 -d, --description、 --events <comma-list> (すべてのイベントの種類への登録は省略)、 --secret、 --allow-insecure-sslです。

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

更新

キーで更新します。--eventsを指定すると、Webhook が subscribe-to-all から指定されたリストに切り替わります。

削除

Webhook をキーで削除します。

Ping

Webhook URL にテスト ping を送信して、接続を確認します。

event-types

Webhook がサブスクライブできるすべてのイベントの種類を一覧表示します。返された名前を create --events または update --eventsで使用します。

uip resource webhooks event-types

参照

• uip resourceの概要—すべてのuip resource動詞に共通する規則。
• 方法: Orchestrator のアセットとキューを管理する — Webhook の作成パターン