SIP Webhooks in VideoSDK
Webhooks allow you to receive real-time notifications about important call events in your SIP integration with VideoSDK. You can configure webhooks either via the VideoSDK dashboard or programmatically using the API.
Available Webhook Events
Below is the list of all supported webhook events:
Event Name | Description |
---|---|
Call Started | Triggered when a new outbound or inbound call is initiated. |
Call Ringing | Triggered when the call is ringing at the destination endpoint. |
Call Answered | Triggered when the call is answered by the recipient. |
Call Ended | Triggered when the call is completed or hung up by either party. |
Call Transferred | Triggered when the call is transferred to another endpoint or participant. |
Call Missed | Triggered when the call is not answered or missed by the recipient. |
Configuring Webhooks
You can set up webhooks using:
- Dashboard: Navigate to the SIP section and add a webhook by specifying your target URL and selecting the events you want to subscribe to.
- API: Use the
POST /v2/sip/webhooks
endpoint to register a webhook.
POST
|
https://api.videosdk.live/v2/sip/webhooks
NodeJS
import fetch from 'node-fetch';
const options = {
method: "POST",
headers: {
"Authorization": "$YOUR_TOKEN",
"Content-Type": "application/json",
},
body: JSON.stringify({
"url" : "https://example.com/webhook",
"events" : ["call-started","call-answered"]
}),
};
const url= `https://api.videosdk.live/v2/sip/webhooks`;
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
API Reference
Got a Question? Ask us on discord