v1

latestOpenAPI 3.0.32026-07-26229361630.0 KB

Appointment Webhooks

Follow-up Appointment Reminder (Instant)

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

Field Definitions

• event: string - The type of event. For instant follow-up appointment reminders, this will be appointment.followup_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

post/registered_url_for_appointment_followup_reminder_instant_webhook_events

Request body

business_idstring

Business ID for the appointment

eventstring

Type of event

event_timeinteger

Event occurrence timestamp

partition_idstring

Partition identifier for the event

transaction_idstring

Unique transaction identifier for the event

Example request

{
  "business_id": "b-23535342",
  "event": "appointment.followup_reminder_instant",
  "event_time": 1741677083454,
  "partition_id": "34k34k3-ea16-438b-81ea-c2e4b296051b:appointment.followup_reminder_instant",
  "transaction_id": "34k34k3-ea16-438b-81ea-c2e4b296051b:appointment.followup_reminder_instant:1741677083454",
  "data": {
    "appointment_id": "34k34k3-ea16-438b-81ea-c2e4b296051b",
    "doctor_id": "23532432142",
    "patient_id": "62342343",
    "clinic_id": "c-dsjfkj23kj3jrfdf"
  }
}