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

Vaccination Reminder

cURL

curl --request POST \
  --url https://{partner_host}/registered_url_for_vaccination_reminder_webhook_events \
  --header 'Content-Type: application/json' \
  --data '
{
  "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"
  }
}
'

import requests

url = "https://{partner_host}/registered_url_for_vaccination_reminder_webhook_events"

payload = {
    "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"
    }
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    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'
    }
  })
};

fetch('https://{partner_host}/registered_url_for_vaccination_reminder_webhook_events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{partner_host}/registered_url_for_vaccination_reminder_webhook_events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{partner_host}/registered_url_for_vaccination_reminder_webhook_events"

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

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{partner_host}/registered_url_for_vaccination_reminder_webhook_events")
  .header("Content-Type", "application/json")
  .body("{\n  \"event\": \"vaccination.reminder\",\n  \"service\": \"appointment\",\n  \"event_time\": 1741677083454,\n  \"partition_id\": \"b-23535342:62342343:vaccination.reminder\",\n  \"transaction_id\": \"62342343-23532432142-1741677083454\",\n  \"data\": {\n    \"doctor_id\": \"23532432142\",\n    \"patient_id\": \"62342343\",\n    \"patient_name\": \"John Doe\",\n    \"doctor_name\": \"Dr. Jane Smith\",\n    \"booking_link\": \"https://eka.care/book/23532432142\",\n    \"due_date\": \"2026-04-15\",\n    \"vaccines\": \"Hepatitis B, MMR\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{partner_host}/registered_url_for_vaccination_reminder_webhook_events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"event\": \"vaccination.reminder\",\n  \"service\": \"appointment\",\n  \"event_time\": 1741677083454,\n  \"partition_id\": \"b-23535342:62342343:vaccination.reminder\",\n  \"transaction_id\": \"62342343-23532432142-1741677083454\",\n  \"data\": {\n    \"doctor_id\": \"23532432142\",\n    \"patient_id\": \"62342343\",\n    \"patient_name\": \"John Doe\",\n    \"doctor_name\": \"Dr. Jane Smith\",\n    \"booking_link\": \"https://eka.care/book/23532432142\",\n    \"due_date\": \"2026-04-15\",\n    \"vaccines\": \"Hepatitis B, MMR\"\n  }\n}"

response = http.request(request)
puts response.read_body

Body

application/json

event · string

Type of event

Example:

"vaccination.reminder"

service · string

Service related to the event

Example:

"appointment"

event_time · integer

Event occurrence timestamp in milliseconds

Example:

1741677083454

partition_id · string

Partition identifier for the event

Example:

"b-23535342:62342343:vaccination.reminder"

transaction_id · string

Unique transaction identifier for the event

Example:

"62342343-23532432142-1741677083454"

data · object

Show child attributes

Response

200 - undefined