Webhook Setup Steps
To set up the generic outbound webhook integration, follow these steps:
- Prepare the required information:
- HTTP Method:
POST(recommended) orGET - Headers:
Content-Type: application/json(primarily for POST)Authorization: Bearer <YOUR_API_KEY>
- Webhook URL: The endpoint where call events will be sent (e.g.,
[https://your-domain.example/velox/events](https://your-domain.example/velox/events)). - API Key: An opaque key that will be included in the
Authorizationheader to authenticate webhook requests.
- HTTP Method:
Submit the configuration details:
Send the required information to our support team.
Tenant configuration:
Our team will configure it for your tenant.
Confirmation:
Wait for confirmation from our team once the integration has been completed and is live.
The attached document contains the complete webhook integration guide, including setup instructions, payload examples, supported event types, and additional implementation details. Please refer to it for more information.
-------------------------------------------------------------------------------------------------------------------------------------------------------
FAQs
Do you support API requests?
We currently offer webhooks. Can you expound on what you like the API integration to do? We are working on Velox V2 platform with a broader API integration feature. We can assess your requirement for V2.
Does the integration include call transcription?
Call transcription is available on a pay-per-use basis through your Velox Dashboard. For this reason, it is not included in the webhook payload.
What are the supported event types?
Please refer to the documentation for more details. We only send call information once the call ends with the appropriate call disposition. We do not send intermediary states like ringing, etc.
Can you provide a sample payload for a completed call with a recording?
Please refer to the payload structure in the documentation.
How long the recording URL stays valid?
There is no expiration for the URL.
Is there authentication required for recording access?
Yes, it requires authentication (user logged in) for download.
Are failed deliveries are retried?
No, we only send as event occurs.