v1

latestOpenAPI 3.0.32026-07-26229361630.0 KB

Appointment Webhooks

Vaccination Reminder

This webhook is triggered when a vaccination reminder is sent for a patient. It notifies the registered endpoint with vaccination details so the receiving system can send appropriate reminders to the patient or doctor.

Field Definitions

• event: string - The type of event. For vaccination reminders, this will be vaccination.reminder.

• service: string - The type of service. This will be appointment.

• event_time: integer - Event occurrence timestamp in milliseconds.

• partition_id: string - Partition identifier for the event in the format {business_id}:{patient_id}:vaccination.reminder.

• transaction_id: string - Unique transaction identifier for the event in the format {patient_id}-{doctor_id}-{timestamp}.

• data: object - Contains detailed information about the vaccination reminder.

• doctor_id: string - Unique identifier for the doctor.

• patient_id: string - Unique identifier for the patient.

• patient_name: string - Name of the patient.

• doctor_name: string - Name of the doctor.

• booking_link: string - Link to book an appointment.

• due_date: string - Due date for the vaccination.

• vaccines: string - Vaccines due for the patient.

Example Webhook Request

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

Method: POST

post/registered_url_for_vaccination_reminder_webhook_events

Request body

eventstring

Type of event

servicestring

Service related to the event

event_timeinteger

Event occurrence timestamp in milliseconds

partition_idstring

Partition identifier for the event

transaction_idstring

Unique transaction identifier for the event

Example request

{
  "event": "vaccination.reminder",
  "service": "appointment",
  "event_time": 1741677083454,
  "partition_id": "b-23535342:62342343:vaccination.reminder",
  "transaction_id": "62342343-23532432142-1741677083454",
  "data": {
    "doctor_id": "23532432142",
    "patient_id": "62342343",
    "patient_name": "John Doe",
    "doctor_name": "Dr. Jane Smith",
    "booking_link": "https://eka.care/book/23532432142",
    "due_date": "2026-04-15",
    "vaccines": "Hepatitis B, MMR"
  }
}