Appointment Reminder
This webhook is triggered when a reminder is sent for an upcoming appointment. It notifies the registered endpoint with appointment details so the receiving system can take appropriate action such as sending notifications to the patient or doctor.
Field Definitions
• event: string - The type of event. For appointment reminders, this will be appointment.reminder.
• business_id: string - The eka ID of the business.
• event_time: integer - Event occurrence timestamp in milliseconds.
• partition_id: string - Partition identifier for the event.
• transaction_id: string - Unique transaction identifier for the event.
• data: object - Contains detailed information about the appointment.
• 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.
Example Webhook Request
Endpoint: https://your-registered-webhook-url.com
Method: POST
Body
Business ID for the appointment
"b-23535342"
Type of event
"appointment.reminder"
Event occurrence timestamp
1741677083454
Partition identifier for the event
"34k34k3-ea16-438b-81ea-c2e4b296051b:appointment.reminder"
Unique transaction identifier for the event
"34k34k3-ea16-438b-81ea-c2e4b296051b:appointment.reminder:1741677083454"