uip or webhooks

Syntax and options for `uip or webhooks`, which manages Orchestrator HTTP callbacks fired on platform events.

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)

List webhooks. Filters: -n, --name, --enabled, --disabled (mutually exclusive). --sort-by <field> sorts results (default Id desc); --all-fields returns the full API response.

get

Get webhook details by key, including subscribed events and SSL settings. --all-fields returns the full API response.

作成

Create a webhook. Requires <name> and --url. Optional -d, --description, --events <comma-list> (omit to subscribe to all event types), --secret, --allow-insecure-ssl.

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

更新

Update by key. Providing --events switches the webhook from subscribe-to-all to the given list. Pass --enabled or --disabled to toggle the webhook's state (mutually exclusive).

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

削除

Delete a webhook by key. Requires -y, --yes — the CLI never prompts for destructive operations.

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

Ping

Send a test ping to the webhook URL to verify connectivity. Delivery is asynchronous — a successful response means the ping was queued, not that the endpoint received it; confirm receipt on the endpoint itself.

event-types

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

uip or webhooks event-types

終了コード

See Exit codes for the shared contract. delete exits 1 if -y, --yes is omitted.

参照

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