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、購読イベント、またはチャネル固有の secret を更新します。channel と testMode フィールドは不変です — 変更するには Webhook を削除して再追加してください。
POST /v1/actions/store/update-webhook
リクエストボディ
| フィールド | 型 | 必須 | 説明 |
|---|
id | string | Yes | Webhook UUID（add-webhook または GraphQL Store.storeWebhooks から返される） |
url | string | No | 送信先 URL を置き換えます。 |
events | string[] | No | 購読イベントタイプを置き換えます |
secret | string | null | No | チャネル固有の認証情報を置き換えます。クリアするには 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!,
});
// Add more events to an existing 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 が見つかりません |
