Sign in

v1

latestOpenAPI 3.0.32026-07-26229361630.0 KB
Doctor Webhooks

Doctor Events

When a Doctor event occurs (such as the start of a practice), a webhook event is sent to registered webhooks with details about the schedule, including the doctor ID, partner doctor ID, and event time. The receiver can use the details from the webhook event to update or manage schedules in the system.

post/registered_url_for_doctor_events

Request body

event'schedule.start_practice' | 'schedule.stop_practice' | 'schedule.available_for_consultation' required

Type of event

event_timeinteger required

Event occurred timestamp

timestampinteger required

Timestamp of the event

client_idstring required

Client ID for the schedule

business_idstring required

Business ID for the schedule

Example request

{
  "event": "schedule.start_practice",
  "event_time": 1730189586,
  "timestamp": 1730189586,
  "client_id": "67978400352a61001d64e9fb",
  "business_id": "174159057718553",
  "data": {
    "doctor_id": "174159057723920",
    "partner_doctor_id": "test-doc-123",
    "clinic_id": "67978400352a61001d64e9fb",
    "partner_clinic_id": "CL04",
    "created_at": 1730189586,
    "modified_at": 1730189586,
    "partner_meta": {
      "key1": "value1"
    }
  }
}

Response

Successfully received the schedule event