跳到主要内容

Webhook

注册和管理 Webhook 事件订阅。6 个 API 命令。

所有 webhook 命令共享以下参数：

参数短参说明
--params路径/查询参数（JSON 格式）
--data请求体（JSON 格式）
--jq-qjq 表达式过滤输出
--dry-run预览请求，不实际执行

create​

注册一个新的 Webhook。

shoplazza webhook create --data '<json_body>'

请求体须包含 address（通知 URL）和 topic（事件名称）。

示例​

shoplazza webhook create --data '{
  "webhook": {
    "topic": "orders/create",
    "address": "https://example.com/hook"
  }
}'

list​

列出所有已注册的 Webhook。

shoplazza webhook list

示例​

shoplazza webhook list --format table

get​

查看指定 Webhook 的详情。

shoplazza webhook get --params '{"webhook_id":"123"}'

update​

更新 Webhook 订阅。

shoplazza webhook update --params '{"webhook_id":"123"}' --data @webhook.json

示例​

shoplazza webhook update --params '{"webhook_id":"123"}' --data '{
  "webhook": {
    "address": "https://example.com/webhooks/orders-v2"
  }
}'

delete​

删除 Webhook 订阅。

shoplazza webhook delete --params '{"webhook_id":"123"}'

count​

统计已注册的 Webhook 数量。

shoplazza webhook count

相关​