Documentation Index
Fetch the complete documentation index at: https://docs.waffo.ai/llms.txt
Use this file to discover all available pages before exploring further.
更新现有 Webhook 的 URL、订阅事件或通道特定凭据。channel 与 testMode 字段不可变 —— 如需变更,请删除后重新添加。
POST /v1/actions/store/update-webhook
认证方式: API Key(需要 owner 或 admin 角色)
请求体
| 字段 | 类型 | 必需 | 说明 |
|---|
id | string | 是 | Webhook UUID(来自 add-webhook 返回值或 GraphQL Store.storeWebhooks) |
url | string | 否 | 替换目标 URL。 |
events | string[] | 否 | 替换订阅的事件类型 |
secret | string | null | 否 | 替换通道特定凭据。传入 null 清空。 |
channel 在 Webhook 记录创建后即固定 —— 如需切换通道,请删除后重新添加。URL 变更会原样接受;商户需自行确保新 URL 与通道匹配。
请求示例
import { WaffoPancake } from "@waffo/pancake-ts";
const client = new WaffoPancake({
merchantId: process.env.WAFFO_MERCHANT_ID!,
privateKey: process.env.WAFFO_PRIVATE_KEY!,
});
// 为已有 Webhook 增加更多事件
await client.webhooks.update({
id: "11111111-2222-3333-4444-555555555555",
events: ["order.completed", "refund.succeeded", "subscription.canceled"],
});
成功响应 (200)
返回更新后的 Webhook 实体。结构与 add-webhook 相同。
响应字段
| 字段 | 类型 | 说明 |
|---|
id | string | Webhook UUID |
storeId | string | 所属门店的 UUID |
channel | string | Webhook 通道(不可变) |
url | string | 目标 Webhook URL |
events | string[] | 订阅的事件类型 |
testMode | boolean | true 对测试交易触发,false 对生产交易触发(不可变) |
secret | string | null | 通道特定凭据,已清空时为 null |
createdAt | string | 创建时间戳(ISO 8601) |
updatedAt | string | 最后更新时间戳(ISO 8601) |
错误响应
| 状态码 | 说明 |
|---|
| 400 | id 不是合法 UUID、events 不是字符串数组,或 secret 不是 string/null |
| 403 | 调用方不是该门店的 owner 或 admin |
| 404 | Webhook 不存在 |