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
Type of serivce
"appointment"
Type of event
"appointment.tele.dr_joined"
Transaction ID for the appointment
"8y3458734657"
Event occured timestamp
1730189586
Event occured timestamp
1730189586
Business ID for the appointment
"174159057718553"
Client ID for the appointment
"67978400352a61001d64e9fb"