ドキュメント/Webhook配信

Webhook配信

文字起こし完了、分析完了、アラートトリガーなどのイベントが発生した際に、設定したエンドポイントにHTTPペイロードを送信します。

⚠️Audit & Exportパックが必要です。Webhook設定はAdminロールが行えます。

Webhookの設定

  1. 管理者 → 設定 に移動します。
  2. Webhook設定 セクションを展開します。
  3. WebhookエンドポイントURLを入力します(HTTPSが必要)。
  4. シークレットキーを入力します(HMAC署名に使用)。
  5. 保存 をクリックします。

テストPing

設定が正しいことを確認するためにテストPingを送信できます。

  1. Webhook設定画面の テストPingを送信 をクリックします。
  2. エンドポイントに同期的にテストペイロードが送信されます。
  3. レスポンスステータスコードが画面に表示されます。

イベントタイプ

イベント説明
transcription.completed文字起こしが完了し、文字起こしデータが利用可能になった
analytics.completedAI分析(サマリー、感情、意図、品質)が完了した
alert.triggeredアラートルールの条件を満たし、アラートがトリガーされた

署名の検証

すべてのWebhookリクエストには X-KoeIQ-Signature ヘッダーが含まれます。これはリクエストボディのHMAC-SHA256ハッシュ(シークレットキーを使用)です。

Pythonでの検証例:

import hmac, hashlib

def verify_signature(body: bytes, secret: str, signature: str) -> bool:
    expected = hmac.new(
        secret.encode(), body, hashlib.sha256
    ).hexdigest()
    return hmac.compare_digest(expected, signature)

次のステップ

ドキュメントトップサポートに問い合わせる →