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