Skip to main content

Webhooks for Analysis

No Separate Webhook Endpoint

There is no separate endpoint for registering webhooks. Webhook URLs are configured when you create an analysis.

How to Configure Webhooks​

Webhooks are configured by passing the webhook_url parameter when creating an analysis via POST /api/v1/analysis/.

Example​

curl -X POST https://api.callcov.com/api/v1/analysis/ \
  -H "X-API-Key: sk_live_abc123..." \
  -F "audio_file=@/path/to/call.wav" \
  -F "agent_id=agent_001" \
  -F "contact_id=customer_12345" \
  -F "webhook_url=https://your-app.com/webhooks/analysis"

When the analysis completes, CallCov will send a POST request to your webhook URL with the complete analysis results.

Webhook Documentation​

For complete webhook implementation guide, see:

  • Webhooks Guide - Comprehensive guide on implementing webhooks
    • Webhook payload format
    • Security with signature validation
    • Retry logic
    • Testing webhooks locally
    • Best practices

Quick Reference​

When to Use Webhooks​

✅ Use webhooks when:

  • Building production applications
  • Processing many analyses
  • Want real-time notifications
  • Want to avoid polling

❌ Don't use webhooks when:

  • Testing locally without ngrok
  • Processing single analyses interactively
  • Building quick prototypes

Webhook Payload​

When analysis completes, you receive the full AnalysisResponse object:

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "completed",
  "results": {
    "compliance": {...},
    "quality": {...},
    "summary": "..."
  },
  ...
}