shoplazza-webhook 是 Shoplazza CLI 中的 webhook 模块技能,用于管理店铺的事件订阅(Webhook)。一个 Webhook 把店铺事件主题(例如 orders/create、orders/fulfilled、products/update)绑定到一个地址,当事件发生时平台会调用该 HTTPS 端点。该模块覆盖订阅的完整增删改查与计数,不提供快捷命令。
主要能力:创建订阅(webhook create)、列出全部订阅(webhook list)、按地址或主题统计数量(webhook count)、查询单个订阅(webhook get)、更新订阅的地址或主题(webhook update)、删除订阅(webhook delete)。创建时 topic 与 address 均为必填,address 需为可访问的 HTTPS URL;查询、更新、删除需提供 webhook id。
使用方式:通过命令行执行,参数与请求体可查阅 shoplazza schema webhook.<cmd>,各命令参数可查看 shoplazza webhook <cmd> --help。授权按域进行,使用 auth login --domain webhook 授权,具体权限范围可用 shoplazza auth scopes 查看。创建与更新在必填字段齐备后可直接执行,删除属破坏性操作,会静默停止事件投递且不可撤销,应先使用 --dry-run 预览,并复述被删除订阅的主题与地址,再等待用户确认。
适用场景:需要在订单创建、订单发货、商品更新等事件发生时通知自建系统的应用开发者;这类“事件通知”需求应使用 webhook 订阅,而非订单或商品类命令。
限制:事件主题的完整枚举无法从命令工具中查询,需通过 schema 或开放平台文档确认,不确定时应询问用户,不应自行编造;地址必须是可访问的 HTTPS 端点。该技能仅覆盖 webhook 领域,跨领域的通用机制(访问层级、输出封装 .data、--dry-run、--jq、schema、api rest、认证与配置、安全协议)需参考 shoplazza-common 技能文档。