Webhook エンドポイント

Webhook エンドポイントを停止

エンドポイントを削除せずに、Webhook エンドポイントの状態を inactive に設定します。

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

呼び出す前に

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

リクエストパラメータ

ヘッダー

X-Api-Key

string必須

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

パスパラメータ

endpoint_id

string必須

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

リクエストボディ

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

結果の確認

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

レスポンス 200 OK

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "id": "we_example",
    "url": "https://example.com/webhook-updated",
    "status": "inactive",
    "subscribed_events": [
      "message.delivered",
      "message.read"
    ],
    "signing_enabled": false,
    "retry_policy": {
      "max_attempts": 1
    }
  }
}

レスポンスボディ

id

string

Webhook エンドポイント識別子（we_...）。

url

string

Webhook 配信を受け取る絶対 HTTP(S) URL。production では HTTPS を推奨します。

format: uri

status

string

エンドポイントのステータス: active または inactive。

enum: active, inactive

subscribed_events[]

string[]

エンドポイントに配信される公開標準イベント種別。["*"] は公開イベントをすべて意味し、provider.raw_event は含みません。

signing_enabled

boolean

署名シークレットが設定され配信が署名される場合は true。

retry_policy

object

max_attempts は初回配信後のリトライ回数で、既定 3、範囲 0〜5。

max_attempts

integer

設定済みの初回配信後リトライ回数（0〜5）。

レスポンス

200

200 OK

リクエスト成功。レスポンスボディの例を参照してください。

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 とワークスペースの有効性を確認します。