← API リファレンス
Webhook エンドポイントPOST

Webhook エンドポイント作成

Webhook 受信側を作成します。subscribed_events はプラットフォーム標準のイベント名（例: message.received、account.status.updated）を受け付け、["*"] ですべてのイベントを購読できます。未知のイベント名は拒否されます。signing_secret は任意で、空にすると署名を無効化できます。retry_policy.max_attempts は非負整数である必要があり、0 はリトライ無効を意味します。整数以外の値は拒否されます。

https://api.unifyport.ai/v1/webhook-endpoints

ヘッダー

X-Api-Key
string必須

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

Content-Type
string必須

JSON のリクエストボディを送る場合は application/json を使用します。

パスパラメータ

このエンドポイントにパスパラメータはありません。

リクエストボディ

url
string必須

Webhook イベントを受け取る HTTPS エンドポイント。

status
string

エンドポイントの状態。通常は active または inactive。

subscribed_events
string[]

エンドポイントに配信されるイベント種別。["*"] ですべてのイベントを購読できます。イベント名の一覧は標準イベントカタログを参照してください。

signing_secret
string

任意の Webhook 署名シークレット。サンプルではプレースホルダを使用してください。

retry_policy
object

max_attempts などのリトライ設定。

レスポンスボディ

id
string

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

url
string

Webhook 配信を受け取る HTTPS URL。

status
string

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

subscribed_events
string[]

エンドポイントに配信されるイベント種別。["*"] はすべてのイベントを意味します。

signing_enabled
boolean

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

retry_policy
object

max_attempts などのリトライ設定。

レスポンス

201
201 Created

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

400
Bad Request

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

401
Unauthorized

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

409
Conflict

要求された操作が、既存のプロバイダアカウントまたはリソースと競合しています。

500
Internal Server Error

サービスで予期しないエラーが発生しました。

リクエスト

curl -X POST https://api.unifyport.ai/v1/webhook-endpoints \
  -H "X-Api-Key: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://example.com/webhook",
  "status": "active",
  "subscribed_events": ["*"],
  "signing_secret": "<WEBHOOK_SIGNING_SECRET>"
}'

レスポンス

{
  "data": {
    "id": "we_example",
    "url": "https://example.com/webhook",
    "status": "active",
    "subscribed_events": ["*"],
    "signing_enabled": true,
    "retry_policy": {
      "max_attempts": 3
    }
  }
}