Appointment Events

When an appointment is created/modified or completed, a webhook event is sent to registered webhooks with details about the appointment, including the appointment ID, status, doctor ID, patient ID, and event type.

Field Definitions

• event: string - The type of resource for which event is generated. For appointments, this will be appointment.

• 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.

• status: string - Status of the appointment. Possible values can be

• ”BK” (Booked),

• “OG” (Ongoing),

• “CM” (Completed with Prescription),

• “CMNP” (Completed without Prescription),

• “CN” (Cancelled).

• action: string - Current action for the appointment. Possible values can be

• created

• modified

• completed

• partner_meta: key value pair specified by partner while creating appointment.

• timestamp: string (ISO 8601) - The date and time when the event occurred.

• custom_attibutes: complete set of custom attributes(inclusing tags and labels) defined against this appointment. occurred.

Example Webhook Request

Endpoint: https://your-registered-webhook-url.com

Method: POST