Doctor Joined Video Call
curl --request POST \
--url https://{partner_host}/registered_url_for_appointment_tele_dr_joined_webhook_events \
--header 'Content-Type: application/json' \
--data '
{
"service": "appointment",
"event": "appointment.tele.dr_joined",
"transaction_id": "8y3458734657",
"event_time": 1730189586,
"timestamp": 1730189586,
"business_id": "174159057718553",
"client_id": "67978400352a61001d64e9fb",
"data": {
"appointment_id": "api-abb67007-1e53-4f0f-b428-a4bc025468a4",
"doctor_id": "174159057723920",
"patient_id": "174678912588458",
"clinic_id": "67978400352a61001d64e9fb",
"video_connect": {
"host_link": "https://xyz.com",
"meet_link": "https://xyz.com",
"vendor": "abc"
}
}
}
'import requests
url = "https://{partner_host}/registered_url_for_appointment_tele_dr_joined_webhook_events"
payload = {
"service": "appointment",
"event": "appointment.tele.dr_joined",
"transaction_id": "8y3458734657",
"event_time": 1730189586,
"timestamp": 1730189586,
"business_id": "174159057718553",
"client_id": "67978400352a61001d64e9fb",
"data": {
"appointment_id": "api-abb67007-1e53-4f0f-b428-a4bc025468a4",
"doctor_id": "174159057723920",
"patient_id": "174678912588458",
"clinic_id": "67978400352a61001d64e9fb",
"video_connect": {
"host_link": "https://xyz.com",
"meet_link": "https://xyz.com",
"vendor": "abc"
}
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
service: 'appointment',
event: 'appointment.tele.dr_joined',
transaction_id: '8y3458734657',
event_time: 1730189586,
timestamp: 1730189586,
business_id: '174159057718553',
client_id: '67978400352a61001d64e9fb',
data: {
appointment_id: 'api-abb67007-1e53-4f0f-b428-a4bc025468a4',
doctor_id: '174159057723920',
patient_id: '174678912588458',
clinic_id: '67978400352a61001d64e9fb',
video_connect: {host_link: 'https://xyz.com', meet_link: 'https://xyz.com', vendor: 'abc'}
}
})
};
fetch('https://{partner_host}/registered_url_for_appointment_tele_dr_joined_webhook_events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{partner_host}/registered_url_for_appointment_tele_dr_joined_webhook_events",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'service' => 'appointment',
'event' => 'appointment.tele.dr_joined',
'transaction_id' => '8y3458734657',
'event_time' => 1730189586,
'timestamp' => 1730189586,
'business_id' => '174159057718553',
'client_id' => '67978400352a61001d64e9fb',
'data' => [
'appointment_id' => 'api-abb67007-1e53-4f0f-b428-a4bc025468a4',
'doctor_id' => '174159057723920',
'patient_id' => '174678912588458',
'clinic_id' => '67978400352a61001d64e9fb',
'video_connect' => [
'host_link' => 'https://xyz.com',
'meet_link' => 'https://xyz.com',
'vendor' => 'abc'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{partner_host}/registered_url_for_appointment_tele_dr_joined_webhook_events"
payload := strings.NewReader("{\n \"service\": \"appointment\",\n \"event\": \"appointment.tele.dr_joined\",\n \"transaction_id\": \"8y3458734657\",\n \"event_time\": 1730189586,\n \"timestamp\": 1730189586,\n \"business_id\": \"174159057718553\",\n \"client_id\": \"67978400352a61001d64e9fb\",\n \"data\": {\n \"appointment_id\": \"api-abb67007-1e53-4f0f-b428-a4bc025468a4\",\n \"doctor_id\": \"174159057723920\",\n \"patient_id\": \"174678912588458\",\n \"clinic_id\": \"67978400352a61001d64e9fb\",\n \"video_connect\": {\n \"host_link\": \"https://xyz.com\",\n \"meet_link\": \"https://xyz.com\",\n \"vendor\": \"abc\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{partner_host}/registered_url_for_appointment_tele_dr_joined_webhook_events")
.header("Content-Type", "application/json")
.body("{\n \"service\": \"appointment\",\n \"event\": \"appointment.tele.dr_joined\",\n \"transaction_id\": \"8y3458734657\",\n \"event_time\": 1730189586,\n \"timestamp\": 1730189586,\n \"business_id\": \"174159057718553\",\n \"client_id\": \"67978400352a61001d64e9fb\",\n \"data\": {\n \"appointment_id\": \"api-abb67007-1e53-4f0f-b428-a4bc025468a4\",\n \"doctor_id\": \"174159057723920\",\n \"patient_id\": \"174678912588458\",\n \"clinic_id\": \"67978400352a61001d64e9fb\",\n \"video_connect\": {\n \"host_link\": \"https://xyz.com\",\n \"meet_link\": \"https://xyz.com\",\n \"vendor\": \"abc\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{partner_host}/registered_url_for_appointment_tele_dr_joined_webhook_events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"service\": \"appointment\",\n \"event\": \"appointment.tele.dr_joined\",\n \"transaction_id\": \"8y3458734657\",\n \"event_time\": 1730189586,\n \"timestamp\": 1730189586,\n \"business_id\": \"174159057718553\",\n \"client_id\": \"67978400352a61001d64e9fb\",\n \"data\": {\n \"appointment_id\": \"api-abb67007-1e53-4f0f-b428-a4bc025468a4\",\n \"doctor_id\": \"174159057723920\",\n \"patient_id\": \"174678912588458\",\n \"clinic_id\": \"67978400352a61001d64e9fb\",\n \"video_connect\": {\n \"host_link\": \"https://xyz.com\",\n \"meet_link\": \"https://xyz.com\",\n \"vendor\": \"abc\"\n }\n }\n}"
response = http.request(request)
puts response.read_bodyAppointment Events
Doctor Joined Video Call
This webhook is triggered when a doctor joins a scheduled video consultation.
Field Definitions
• event: string - The type of resource for which event is generated. When doctor joins video call, this will be appointment.tele.dr_joined.
• service: string - The type of service. For appointments, this will be appointment.
• business_id: string - The eka id of business.
• event_time: integer - Event occurrence timestamp.
• timestamp: integer - Event occurrence timestamp.
• client_id: string- Client ID for the appointment
• transaction_id: string - The id of the transaction.
• data: object - Contains detailed information about the appointment event.
• appointment_id: string - Unique identifier for the appointment.
• doctor_id: string - Unique identifier for the doctor.
• patient_id: string - Unique identifier for the patient.
• clinic_id: string - Unique identifier for the clinic.
• video_connect: object - Contains information about vendor, meet_link and host_link.
• host_link: string - Link for the doctor.
• meet_link: string - Link for the meeting patient.
• vendor: string - The video conferencing service provider.
Example Webhook Request
Endpoint: https://your-registered-webhook-url.com
Method: POST
POST
/
registered_url_for_appointment_tele_dr_joined_webhook_events
Doctor Joined Video Call
curl --request POST \
--url https://{partner_host}/registered_url_for_appointment_tele_dr_joined_webhook_events \
--header 'Content-Type: application/json' \
--data '
{
"service": "appointment",
"event": "appointment.tele.dr_joined",
"transaction_id": "8y3458734657",
"event_time": 1730189586,
"timestamp": 1730189586,
"business_id": "174159057718553",
"client_id": "67978400352a61001d64e9fb",
"data": {
"appointment_id": "api-abb67007-1e53-4f0f-b428-a4bc025468a4",
"doctor_id": "174159057723920",
"patient_id": "174678912588458",
"clinic_id": "67978400352a61001d64e9fb",
"video_connect": {
"host_link": "https://xyz.com",
"meet_link": "https://xyz.com",
"vendor": "abc"
}
}
}
'import requests
url = "https://{partner_host}/registered_url_for_appointment_tele_dr_joined_webhook_events"
payload = {
"service": "appointment",
"event": "appointment.tele.dr_joined",
"transaction_id": "8y3458734657",
"event_time": 1730189586,
"timestamp": 1730189586,
"business_id": "174159057718553",
"client_id": "67978400352a61001d64e9fb",
"data": {
"appointment_id": "api-abb67007-1e53-4f0f-b428-a4bc025468a4",
"doctor_id": "174159057723920",
"patient_id": "174678912588458",
"clinic_id": "67978400352a61001d64e9fb",
"video_connect": {
"host_link": "https://xyz.com",
"meet_link": "https://xyz.com",
"vendor": "abc"
}
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
service: 'appointment',
event: 'appointment.tele.dr_joined',
transaction_id: '8y3458734657',
event_time: 1730189586,
timestamp: 1730189586,
business_id: '174159057718553',
client_id: '67978400352a61001d64e9fb',
data: {
appointment_id: 'api-abb67007-1e53-4f0f-b428-a4bc025468a4',
doctor_id: '174159057723920',
patient_id: '174678912588458',
clinic_id: '67978400352a61001d64e9fb',
video_connect: {host_link: 'https://xyz.com', meet_link: 'https://xyz.com', vendor: 'abc'}
}
})
};
fetch('https://{partner_host}/registered_url_for_appointment_tele_dr_joined_webhook_events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{partner_host}/registered_url_for_appointment_tele_dr_joined_webhook_events",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'service' => 'appointment',
'event' => 'appointment.tele.dr_joined',
'transaction_id' => '8y3458734657',
'event_time' => 1730189586,
'timestamp' => 1730189586,
'business_id' => '174159057718553',
'client_id' => '67978400352a61001d64e9fb',
'data' => [
'appointment_id' => 'api-abb67007-1e53-4f0f-b428-a4bc025468a4',
'doctor_id' => '174159057723920',
'patient_id' => '174678912588458',
'clinic_id' => '67978400352a61001d64e9fb',
'video_connect' => [
'host_link' => 'https://xyz.com',
'meet_link' => 'https://xyz.com',
'vendor' => 'abc'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{partner_host}/registered_url_for_appointment_tele_dr_joined_webhook_events"
payload := strings.NewReader("{\n \"service\": \"appointment\",\n \"event\": \"appointment.tele.dr_joined\",\n \"transaction_id\": \"8y3458734657\",\n \"event_time\": 1730189586,\n \"timestamp\": 1730189586,\n \"business_id\": \"174159057718553\",\n \"client_id\": \"67978400352a61001d64e9fb\",\n \"data\": {\n \"appointment_id\": \"api-abb67007-1e53-4f0f-b428-a4bc025468a4\",\n \"doctor_id\": \"174159057723920\",\n \"patient_id\": \"174678912588458\",\n \"clinic_id\": \"67978400352a61001d64e9fb\",\n \"video_connect\": {\n \"host_link\": \"https://xyz.com\",\n \"meet_link\": \"https://xyz.com\",\n \"vendor\": \"abc\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{partner_host}/registered_url_for_appointment_tele_dr_joined_webhook_events")
.header("Content-Type", "application/json")
.body("{\n \"service\": \"appointment\",\n \"event\": \"appointment.tele.dr_joined\",\n \"transaction_id\": \"8y3458734657\",\n \"event_time\": 1730189586,\n \"timestamp\": 1730189586,\n \"business_id\": \"174159057718553\",\n \"client_id\": \"67978400352a61001d64e9fb\",\n \"data\": {\n \"appointment_id\": \"api-abb67007-1e53-4f0f-b428-a4bc025468a4\",\n \"doctor_id\": \"174159057723920\",\n \"patient_id\": \"174678912588458\",\n \"clinic_id\": \"67978400352a61001d64e9fb\",\n \"video_connect\": {\n \"host_link\": \"https://xyz.com\",\n \"meet_link\": \"https://xyz.com\",\n \"vendor\": \"abc\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{partner_host}/registered_url_for_appointment_tele_dr_joined_webhook_events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"service\": \"appointment\",\n \"event\": \"appointment.tele.dr_joined\",\n \"transaction_id\": \"8y3458734657\",\n \"event_time\": 1730189586,\n \"timestamp\": 1730189586,\n \"business_id\": \"174159057718553\",\n \"client_id\": \"67978400352a61001d64e9fb\",\n \"data\": {\n \"appointment_id\": \"api-abb67007-1e53-4f0f-b428-a4bc025468a4\",\n \"doctor_id\": \"174159057723920\",\n \"patient_id\": \"174678912588458\",\n \"clinic_id\": \"67978400352a61001d64e9fb\",\n \"video_connect\": {\n \"host_link\": \"https://xyz.com\",\n \"meet_link\": \"https://xyz.com\",\n \"vendor\": \"abc\"\n }\n }\n}"
response = http.request(request)
puts response.read_bodyBody
application/json
Type of serivce
Example:
"appointment"
Type of event
Example:
"appointment.tele.dr_joined"
Transaction ID for the appointment
Example:
"8y3458734657"
Event occured timestamp
Example:
1730189586
Event occured timestamp
Example:
1730189586
Business ID for the appointment
Example:
"174159057718553"
Client ID for the appointment
Example:
"67978400352a61001d64e9fb"
Show child attributes
Show child attributes
Response
200 - undefined
Was this page helpful?
⌘I