<aside> 🌎
Webhooks are automated HTTP callbacks that enable real-time event notifications. When a specific event that you subscribe to occurs in Vaspian One, the system immediately sends an HTTP POST request to your configured endpoint with relevant event data.
This push-based approach allows your applications to react to call events instantly without continuously polling the Vaspian API. Webhooks are ideal for integrating telephony events into CRM systems, analytics platforms, logging services, or custom business workflows.
</aside>
sequenceDiagram
participant Caller
participant SBC as Vaspian SBC
participant CRS as Call Router
participant Ext as Extension 101
participant WH as Customer <br> Webhook Endpoint
participant Store as Customer Storage <br> (Transcipt & Recording)
Caller->>SBC: Inbound call
SBC->>CRS: Create session
CRS->>Ext: Ringing
CRS-->>WH: HTTP POST event=Call Ringing
Ext->>CRS: Answer
CRS-->>WH: HTTP POST event=Call Answered
Ext<<->>Caller: Conversation
CRS-->>WH: HTTP POST event=Call CDR
CRS-->>WH: POST event=Call Recording (file_url token)
CRS->>Store: Save recording
CRS-->>WH: HTTP POST event=Call Transcription (file_url token)
CRS->>Store: Save transcript
WH->>CRS: 2xx ACK for each event
Vaspian One can send webhooks for:
Webhook events are configurable on a per-extension basis, giving you granular control over which extensions trigger notifications and which events you want to capture. This allows you to:
For example, you might configure your sales extensions to send Call Answered and Call Ended events to your CRM, while support extensions send Call Recording and Call Transcription events to your quality assurance system.
| Event | Description |
|---|---|
| Call Initiated | Triggered when a call is created but not yet answered. |
| Call Ringing | Triggered when the remote party is being alerted. |
| Call Answered | Triggered when the call is answered. |
| Call Ended | Triggered when the call is terminated. |
| Call Failed | Triggered if the call fails to connect. |
| Call CDR | Emitted after the call ends with detailed Call Detail Record (CDR). |
| Call Recording | Emitted when a recording of the call is available. |
| Call Transcription | Emitted when a transcription of the recording is available. |
| Response Codes | HTTP Response codes |