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

列表

列出 Webhook。筛选器：-n, --name、--enabled、--disabled（互斥）。--sort-by <field> 对结果进行排序（默认为 Id desc）； --all-fields 返回完整的 API 响应。

get

按密钥获取 Webhook 详细信息，包括订阅的事件和 SSL 设置。--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 从“订阅全部”切换到给定列表。传递 --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 已排队，但并不意味着端点已收到；在端点本身上确认收据。

事件类型

列出 Webhook 可以订阅的所有事件类型。将返回的名称与create --events或update --events一起使用。

uip or webhooks event-types

退出代码

请参阅共享合同的退出代码。如果省略 delete，1 将退出 -y, --yes。

另请参阅

• uip or概述— 每个uip or动词的共享约定。
• 操作方法：管理 Orchestrator 资产和队列— Webhook 创建模式。