Appointment Reminder (Instant)

This webhook is triggered to send an instant reminder for an upcoming appointment. Unlike the standard reminder which is scheduled in advance, this reminder event is sent immediately. The receiving system can use this to trigger instant alerts to the patient or doctor.

Field Definitions

• event: string - The type of event. For instant appointment reminders, this will be appointment.reminder_instant.

• 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