Skip to main content
ベース URL:https://app.comdesk.com/api/v1
Webhook 管理は open_api_advanced ライセンスと、webhooks:manage スコープを持つキーが必要です。イベントペイロード、署名検証、再送スケジュールは Webhook ガイド を参照してください。

Webhook を登録する

POST /webhooks

ボディ

string
required
POST 配信を受信する HTTPS エンドポイント。外部から到達可能である必要があります。
array
required
購読するイベント種別。例:["call.completed", "call.missed"]イベント一覧 を参照。
object
配信を絞り込みます。project_ids(整数の配列)と call_status(文字列の配列、例:["missed_call", "no_answer"])に対応。

Webhook 一覧

GET /webhooks テナントのすべての Webhook を返します。

Webhook の更新

PUT /webhooks/{webhookId} 登録と同じフィールドを受け付けます。変更分のみ送信してください。

Webhook の削除

DELETE /webhooks/{webhookId} Webhook を論理削除します。配信は即時に停止します。

Webhook のテスト

POST /webhooks/{webhookId}/test 設定済み URL にサンプルペイロードを送信し、接続性と署名処理を検証できます。
テストエンドポイントの正確なレスポンスボディはソース PRD に記載されていません。稼働中の API でご確認ください。