メインコンテンツへスキップ
ストアから Webhook を削除します。これは物理削除です — 行は store.store_webhooks から即座に削除され、ソフトデリートフラグはありません。過去の webhook_deliveries レコードは監査のために保持されます(storeWebhookId 外部キーは null に設定されます)。
POST /v1/actions/store/remove-webhook
認証: API Key(owner または admin ロールが必要)

リクエストボディ

フィールド必須説明
idstringYesWebhook UUID

リクエスト例

import { WaffoPancake } from "@waffo/pancake-ts";

const client = new WaffoPancake({
  merchantId: process.env.WAFFO_MERCHANT_ID!,
  privateKey: process.env.WAFFO_PRIVATE_KEY!,
});

const { webhook } = await client.webhooks.remove({
  id: "11111111-2222-3333-4444-555555555555",
});
// webhook contains a snapshot of the row before deletion

成功レスポンス (200)

削除直前に存在していた Webhook エンティティを返します(呼び出し元が削除内容を確認できるようにするため)。形状は add-webhook と同じです。

レスポンスフィールド

フィールド説明
idstringWebhook UUID
storeIdstring所属ストアの UUID
channelstringWebhook チャネル
urlstring送信先 Webhook URL
eventsstring[]購読するイベントタイプ
testModebooleantrue はテストトランザクションで発火、false は本番で発火
secretstring | nullチャネル固有の認証情報、未設定の場合は null
createdAtstring作成タイムスタンプ(ISO 8601)
updatedAtstring最終更新タイムスタンプ(ISO 8601)

エラー

リトライポリシー:4xx は一切リトライしない — リクエストを修正してから再送信。5xx は指数バックオフでリトライ(5s 開始、最大 3 回)。
ステータスerrors[0].message意味推奨処理
400Missing required field: idid が指定されていないリクエストボディを修正して再送信
400id must be a valid UUIDid が有効な UUID ではないid を修正して再送信
403Not authorized to manage webhooks for this store呼び出し元の所属ストアにおける merchant ロールが owner または admin ではない必要なロールを持つ API Key に切り替え
404Webhook not found指定された id の webhook が存在しない(またはすでに削除済み)Webhook はすでに存在しない — 成功として扱い、ローカル状態を整合
500Internal server errorサーバ側の予期しない障害指数バックオフでリトライ(5s 開始、最大 3 回)