Webhook エンドポイント

Webhook エンドポイント削除

Webhook エンドポイントを削除します。成功時にレスポンスボディは返されません。

DELETEhttps://api.unifyport.ai/v1/webhook-endpoints/{endpoint_id}

対応チャネル

all

呼び出す前に

対象ワークスペースの X-Api-Key をサーバー側で使用します。実行前にすべてのプレースホルダーを置き換えます。

パラメーターの取得元

account_id: アカウント作成・取得応答の data.id を使います。識別子は X-Api-Key のワークスペースに属します。アカウント取得

リクエストパラメータ

ヘッダー

X-Api-Key

string必須

ワークスペース API キー。このヘッダーからワークスペースを特定します。

パスパラメータ

endpoint_id

string必須

webhook endpoints ルートで使用される識別子。

クエリパラメータ

account_id

string

任意の公開アカウント ID（例: acc_example）。空文字列、空白のみ、重複指定は不可。パラメータ名は正確に account_id とし、大文字・小文字の異なる表記は省略扱いではなく 400 invalid_request になります。一覧で省略するとワークスペースのエンドポイントのみ、指定するとアカウント独自の設定のみを返します（独自設定がなければ data=[]、継承したワークスペース設定は含みません）。取得・無効化・削除では既存のアカウント帰属のみを検証し、不一致は 400 invalid_request になります。指定したアカウントが存在しないか現在のワークスペースに属さない場合は 404 account_not_found (20020) になります。

minLength: 1 · pattern: \S

リクエストボディ

このエンドポイントは JSON ボディを必要としません。

結果の確認

204 は削除完了を表し、応答本文はありません。調査用に X-Request-Id を保存します。削除先への新規配信は期待しないでください。すでに送信中のリクエストの取り消しは保証されません。

レスポンス 204 No Content

レスポンスボディはありません。

レスポンス

204

204 No Content

リクエスト成功。レスポンスボディはありません。

400

Bad Request

リクエストボディ、パス、またはパラメータが不正です。

401

Unauthorized

X-Api-Key ヘッダが欠落しているか無効です。

404

Not Found

要求されたリソースが見つかりません。error.code と現在の操作を合わせて確認してください。

失敗時の対応

HTTP 状態と error.code/numeric_code を確認し、request_id を保存します。原因に応じてパラメーター修正・認証・状態確認を行い、送信や書き込みの再試行前に前回の結果を確認します。エラーリファレンス

invalid_request · 10000 · 400: 必須項目、形式、チャネルの条件を確認して修正します。
missing_api_key · 11000 · 401: X-Api-Key とワークスペースの有効性を確認します。
invalid_api_key · 11001 · 401: X-Api-Key とワークスペースの有効性を確認します。