Sign in

v1

latestOpenAPI 3.0.32026-07-26229361630.0 KB
Appointment Webhooks

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

Request body

servicestring

Type of serivce

eventstring

Type of event

transaction_idstring

Transaction ID for the appointment

event_timeinteger

Event occured timestamp

timestampinteger

Event occured timestamp

business_idstring

Business ID for the appointment

client_idstring

Client ID for the appointment

Example request

{
  "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"
    }
  }
}