Skip to main content
GuidesAPI ReferenceSupport

Voice Session Summary (VSS) webhook

The Voice Session Summary (VSS) webhook is sent after a voice session ends. It provides a single end-of-session record you can use for monitoring, reporting, retries, and reconciliation.

VSS is configured per subaccount as a webhook of type VSS using the Webhooks API.

When VSS is sent​

VSS is sent after the platform completes a session (success, no-answer, busy, failed, or error). If the session cannot be created or completed, the payload may include an errorDetails object and/or sessionStatus: "ERROR".

Configure VSS (Webhooks API)​

You register VSS using the Webhooks API:

Example: register a VSS webhook​

POST /api/v1/subaccounts/{subaccountId}/webhooks

{
  "active": true,
  "type": "VSS",
  "url": "https://your-domain.com/voice/webhooks/vss"
}

Verify and manage VSS webhook (Webhooks API)​

Check current webhook configuration​

GET /api/v1/subaccounts/{subaccountId}/webhooks

Use this to verify your VSS webhook URL is registered and enabled.

API reference: Get webhooks information

Delete VSS webhook​

DELETE /api/v1/subaccounts/{subaccountId}/webhooks/VSS

Use this to remove the VSS configuration for the subaccount (for example, before re-registering with a new URL).

API reference: Delete a specific type of webhook

Choose the right payload schema​

VSS payloads have product-specific variants:

Error codes​

If you receive sessionStatus: "ERROR" or errorDetails, see:

Support Channels​