UIP または Webhook

「uip または Webhook」の構文とオプション - プラットフォーム イベントで発生する Orchestrator の HTTP コールバックを管理します。

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

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

概要

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)

Webhook のリストを表示します。フィルター: -n, --name、 --enabled、 --disabled (相互に排他的)。--sort-by <field> 結果を並べ替えます (既定 Id desc)。 --all-fields 完全な API 応答を返します。

get

サブスクライブしたイベントや SSL 設定など、Webhook の詳細をキーで取得します。--all-fields は完全な API 応答を返します。

作成

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

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

更新

キーで更新。--eventsを指定すると、Webhook が subscribe-to-all から指定したリストに切り替わります。--enabled または --disabled を渡すと、Webhook のステートが切り替わります (相互に排他的)。

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

削除

Webhook をキーで削除する-y, --yesが必要 — CLI で破壊的な操作が求められることはありません。

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

Ping

Webhook の URL にテスト ping を送信して、接続を確認します。配信は非同期です。正常な応答は、ping がキューに入ったことを意味します。エンドポイントが ping を受信したということではありません。エンドポイント自体で受信を確認します。

event-types

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

uip or webhooks event-types

終了コード

共有コントラクトの 終了コード を参照してください。-y, --yesを省略するとdelete1終了します。

参照

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