API リファレンス

Webhook エンドポイント

Webhook エンドポイント削除

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

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

呼び出す前に

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

リクエストパラメータ

ヘッダー

X-Api-Key
string必須

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

パスパラメータ

endpoint_id
string必須

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

リクエストボディ

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

結果の確認

設定の成功は配信成功ではありません。関連イベントを発生させ、受信側で到着・署名・応答を確認します。

レスポンス 204 No Content

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

レスポンス

204

204 No Content

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

400

Bad Request

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

401

Unauthorized

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

失敗時の対応

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

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