Webhookシークレットの削除

DELETEhttps://api.omise.co/webhooks/secrets/:id

アカウントからWebhook署名シークレットを削除します。この操作は元に戻せません。現在のシークレットを削除する前に、代替シークレットを作成してデプロイしていることを確認してください。そうしないと、Webhook署名の検証が失敗します。

---

リクエストパラメータ

必須 - 1項目必須パラメータ

▼

`id`STRING(required)

削除するWebhookシークレットID（whsec_で始まる有効なWebhookシークレットIDである必要があります）。

Example:"whsec_test_5xuy4w91xqz7d1w9u0t"

Constraints:有効なWebhookシークレットIDである必要があります

---

レスポンス

200

Webhookシークレットが正常に削除されました

Webhookシークレットが完全に削除されました。このシークレットを使用してWebhookを検証することはできなくなりました。

削除の影響：

• シークレットは完全に削除され、復元できません
• このシークレットで作成されたWebhook署名は検証できなくなります
• これが唯一のシークレットだった場合、新しいシークレットを作成するまでWebhook検証は失敗します
• 削除前にアプリケーションが代替シークレットで設定されていることを確認してください

400

不正なリクエスト

無効なWebhookシークレットID形式です。

一般的な原因：

• WebhookシークレットIDの形式が無効
• IDがwhsec_で始まっていない

401

認証エラー

認証に失敗しました。無効または欠落したAPIキーです。

一般的な原因：

• Authorizationヘッダーの欠落
• 無効なシークレットキー
• シークレットキーの代わりにパブリックキーを使用
• 不正なHTTP Basic Auth形式

404

見つかりません

Webhookシークレットが見つかりません。

一般的な原因：

• WebhookシークレットIDが存在しない
• Webhookシークレットが既に削除されている
• シークレットが別のアカウントに属している

5xx

サーバーエラー

サーバー側でエラーが発生しました。これはまれですが、適切に処理する必要があります。

対処方法：

• 指数バックオフでリクエストを再試行
• status.omise.coでサービス障害を確認
• 詳細なガイダンスについてはエラー処理を参照

---

コードサンプル

cURL

curl https://api.omise.co/webhooks/secrets/whsec_test_5xuy4w91xqz7d1w9u0t \
  -X DELETE \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

secret = Omise::WebhookSecret.destroy('whsec_test_5xuy4w91xqz7d1w9u0t')

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

secret = omise.WebhookSecret.retrieve('whsec_test_5xuy4w91xqz7d1w9u0t')
secret.destroy()

Node.js

const omise = require('omise')({
  secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});

const secret = await omise.webhookSecrets.destroy('whsec_test_5xuy4w91xqz7d1w9u0t');

PHP

<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');

$secret = OmiseWebhookSecret::retrieve('whsec_test_5xuy4w91xqz7d1w9u0t');
$secret->destroy();

Java

Client client = new Client.Builder()
    .secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
    .build();

WebhookSecret secret = client.webhookSecrets().destroy("whsec_test_5xuy4w91xqz7d1w9u0t");

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var secret = await client.WebhookSecrets.Destroy("whsec_test_5xuy4w91xqz7d1w9u0t");

Go

client, _ := omise.NewClient(
    "pkey_test_5xuy4w91xqz7d1w9u0t",
    "skey_test_5xuy4w91xqz7d1w9u0t",
)

deleted, _ := client.WebhookSecrets().Destroy("whsec_test_5xuy4w91xqz7d1w9u0t")

---

エラーコードと結果コード

一般的なエラーコード

コード	説明	解決方法
bad_request	無効なWebhookシークレットID形式	ID形式がwhsec_で始まることを確認
authentication_failure	無効なAPIキー	シークレットキーが正しいことを確認
not_found	Webhookシークレットが見つからない	WebhookシークレットIDが存在することを確認

削除レスポンス

フィールド	説明
object	オブジェクトタイプ（常に "webhook_secret"）
id	削除されたWebhookシークレットのID
deleted	ブールフラグ（削除成功時は常にtrue）
livemode	ライブモードのシークレットだったかどうか

---

重要な注意事項

キーローテーションのベストプラクティス

Webhookシークレットをローテーションする際は、検証失敗を避けるために以下の手順に従ってください：

1. Webhookシークレット作成エンドポイントを使用して新しいシークレットを作成
2. 古いシークレットと新しいシークレットの両方を使用してWebhookを検証するようにアプリケーションを更新
3. 本番環境に変更をデプロイ
4. 新しいシークレットが正しく動作していることを確認を待つ
5. このエンドポイントを使用して古いシークレットを削除

ダウンタイムの回避

唯一のアクティブなWebhookシークレットを削除した場合：

• 受信Webhookは署名検証に失敗します
• アプリケーションはWebhookの真正性を検証できなくなります
• 一時的に未検証のWebhookを受け入れるか、後で検証するためにキューに入れる必要があります

アクティブなシークレットを削除する前に、常に代替シークレットがデプロイされていることを確認してください。

---

🔑API認証情報

▼

試してみる

必須 - 1項目

▼

id(必須)

あなたのIP: ...読み込み中...