Docs/Webhook Delivery

Webhook Delivery

Receive HMAC-signed HTTP payloads when transcription completes, analytics run, or alert rules trigger.

⚠️Requires Audit & Export Pack. Only Admin roles can configure webhooks.

Configuring webhooks

  1. Go to Admin → Settings.
  2. Expand the Webhook Settings section.
  3. Enter the webhook endpoint URL (HTTPS required).
  4. Enter a secret key (used for HMAC signing).
  5. Click Save.

Test ping

Send a test ping to verify your endpoint is reachable.

  1. Click Send Test Ping in the Webhook Settings section.
  2. A synchronous test payload is fired to your endpoint.
  3. The HTTP response status is shown on screen.

Event types

EventDescription
transcription.completedTranscription finished and transcript data is available
analytics.completedAI analytics (summary, emotion, intent, quality) have completed
alert.triggeredAn alert rule's condition was met and the alert fired

Signature verification

Every webhook request includes an X-KoeIQ-Signature header — an HMAC-SHA256 hex digest of the raw request body, keyed with your webhook secret.

Python verification example:

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)

Next steps

All DocsContact Support →