1. Webhooks
  • HMS Sovereign API
  • Get started
    • Authentication
    • Introduction
    • Quickstart
  • Core concepts
    • Assistants
    • Calls
    • Phone Numbers
    • Webhooks
  • Platform
    • Billing & Credits
    • EU Data Sovereignty
    • Voice Selection
    • Whitelabel Portal
  • Webhooks
    • Assistant Request
    • End of Call Report
    • Webhooks Overview
    • Webhook Security
    • Status Update
    • Tool Calls
  • Configuration
    • Analysis Templates
    • Custom Tools
    • SIP Trunks
    • Tool Templates
  • Features
    • AI Generation
    • Autonomous Silence Handling
    • Call Analysis
    • Call Transfers
    • Campaigns Setup
    • Outbound Campaigns
    • Voicemail Detection
    • Web Calls
  • Integrations
    • BYOK Setup
    • Provider Pricing
    • xAI Grok Integration
  • Reference
    • Error Codes
    • Rate Limits
    • Troubleshooting
Documentation
API Reference
Documentation
API Reference
Book a meeting
Linkedin
Github
  1. Webhooks

Webhooks Overview

Webhooks allow you to receive real-time notifications about call events. When events occur, HMS Sovereign sends HTTP POST requests to your configured endpoint.

Available Webhooks#

WebhookEndpoint IDDescription
Assistant Request25570929Pre-call configuration
Tool Calls25570944Function execution
Status Update25570945Call lifecycle events
End of Call Report25570946Post-call summary

Configuration#

Configure webhooks on your assistant:

Request Format#

All webhooks send POST requests with:

Headers#

HeaderDescription
Content-Typeapplication/json
User-AssistantHMS-Sovereign/1.0
X-Webhook-EventEvent type
X-Webhook-TimestampUnix timestamp
X-Webhook-SignatureHMAC-SHA256 signature

Body Structure#

{
  "message": {
    "type": "status-update",
    "timestamp": "2025-12-13T12:00:00.000Z",
    "call": {
      "id": "5c4d030f-43e3-4e65-899e-8148521e660f",
      "type": "inbound_phone_call",
      "status": "in-progress"
    },
    "phone_number": {
      "number": "+31850835037",
      "name": "HMS Sovereign Demo"
    },
    "customer": {
      "number": "+31612345678"
    }
  }
}

Response Requirements#

WebhookResponse RequiredTimeout
Assistant RequestYes (config or empty)5 seconds
Tool CallsYes (result)10 seconds
Status UpdateNo (ignored)-
End of Call ReportNo (ignored)-

Next Steps#

Assistant Request Webhook - Dynamic assistant configuration
Tool Calls Webhook - Function execution
Security - Verify webhook signatures
Modified at 2026-03-17 10:59:50
Previous
End of Call Report
Next
Webhook Security
Built with