ウェブフックエンドポイントを取得する

GET /v1/webhook-endpoints/{endpoint_id} · 権限 webhook-endpoints:read · すべてのプラン

1 件のウェブフックエンドポイントを返します。ETag ヘッダーはエンドポイントのバージョンであり、更新 と 削除 で使用する If-Match の値になります。署名シークレットはここでは返されません。

リクエスト

フィールド 型 必須 説明
endpoint_id path はい ウェブフックエンドポイント ID（whe_…）。

レスポンス

200 OK とともに、エンドポイントが返されます。

フィールド 説明
id エンドポイント ID（whe_…）。
key 環境内で一意の安定したキー。
url 受信先 URL。
description 自由記述のテキスト。ない場合は空文字列。
event_types 選択されたカタログのイベントタイプ。空の場合は、大量発生型を除くすべてのタイプ。
event_schema_versions イベントタイプからスキーマバージョンへの上書き設定。
payload_mode thin または full。
status enabled、disabled_by_user、disabled_by_failure（5 日間成功した配信がなく、かつ 10 件以上の配信が放棄された場合）、または disabled_by_receiver（受信側が 410 Gone を返した場合）。更新 で "status": "enabled" を指定すると再び有効にできます。無効だった期間のイベントは、リプレイを使用して再送してください。
rate_limit_per_second このエンドポイントへの配信レートの上限。
previous_secret_expires_at ローテーション後、古いシークレットで引き続き配信に署名される期間の終了時刻。それ以外の場合は null。
last_success_at 最後に成功した配信の時刻。ない場合は null。
failing_since 連続して失敗した配信の開始時刻。ない場合は null。
version バージョン。ETag ヘッダーの値と同じです。
created_at、updated_at タイムスタンプ。 
{
  "id": "whe_01k8a3m5q7t9v1w3x5y7z9b2c4",
  "key": "crm-sync",
  "url": "https://hooks.example.com/keenauth",
  "description": "CRM sync",
  "event_types": ["user.created", "user.updated"],
  "event_schema_versions": {"user.created": 1},
  "payload_mode": "thin",
  "status": "enabled",
  "rate_limit_per_second": 50,
  "previous_secret_expires_at": null,
  "last_success_at": "2026-10-26T09:12:00Z",
  "failing_since": null,
  "version": 3,
  "created_at": "2026-10-26T09:00:00Z",
  "updated_at": "2026-10-26T10:00:00Z"
}

エラー

HTTP code 発生条件
404 not_found この環境に該当するエンドポイントがありません（別の環境のエンドポイントや不正な ID の場合も含みます）。
401 unauthenticated 認証情報が欠落しているか、無効または取り消されています。
403 insufficient_permissions 認証情報に webhook-endpoints:read 権限がありません。
429 rate_limited レート制限を超えました。Retry-After の期間を待ってから再試行してください。
503 service_unavailable ウェブフックの管理機能は一時的に利用できません。Retry-After の期間を待ってから再試行してください。

例

curl -i https://api.eu.keenauth.com/v1/webhook-endpoints/whe_01k8a3m5q7t9v1w3x5y7z9b2c4 \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY"

CLI: keenauth webhook-endpoints get whe_01k8a3m5q7t9v1w3x5y7z9b2c4