---
title: "Vaccination Reminder"
method: POST
path: "/registered_url_for_vaccination_reminder_webhook_events"
tags: ["Appointment Webhooks"]
---

# Vaccination Reminder

`POST /registered_url_for_vaccination_reminder_webhook_events`

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](https://your-registered-webhook-url.com)

**Method:** POST

## Request body

- object
  - `event` string — Type of event
  - `service` string — Service related to the event
  - `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
    - `doctor_id` string — Identifier for the doctor in Eka
    - `patient_id` string — Identifier for the patient in Eka
    - `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

## Response `200`

---

[API](https://skmtc.dev/eka/apis/eka-developer-apis.md) · [All operations](https://skmtc.dev/eka/apis/eka-developer-apis/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/eka/eka-developer-apis/revisions/9ea23456f722/schema)