curl --request POST \
--url https://{partner_host}/registered_url_for_appointment_followup_reminder_instant_webhook_events \
--header 'Content-Type: application/json' \
--data '
{
"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"
}
}
'import requests
url = "https://{partner_host}/registered_url_for_appointment_followup_reminder_instant_webhook_events"
payload = {
"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"
}
}
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({
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'
}
})
};
fetch('https://{partner_host}/registered_url_for_appointment_followup_reminder_instant_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_appointment_followup_reminder_instant_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([
'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'
]
]),
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_appointment_followup_reminder_instant_webhook_events"
payload := strings.NewReader("{\n \"business_id\": \"b-23535342\",\n \"event\": \"appointment.followup_reminder_instant\",\n \"event_time\": 1741677083454,\n \"partition_id\": \"34k34k3-ea16-438b-81ea-c2e4b296051b:appointment.followup_reminder_instant\",\n \"transaction_id\": \"34k34k3-ea16-438b-81ea-c2e4b296051b:appointment.followup_reminder_instant:1741677083454\",\n \"data\": {\n \"appointment_id\": \"34k34k3-ea16-438b-81ea-c2e4b296051b\",\n \"doctor_id\": \"23532432142\",\n \"patient_id\": \"62342343\",\n \"clinic_id\": \"c-dsjfkj23kj3jrfdf\"\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_appointment_followup_reminder_instant_webhook_events")
.header("Content-Type", "application/json")
.body("{\n \"business_id\": \"b-23535342\",\n \"event\": \"appointment.followup_reminder_instant\",\n \"event_time\": 1741677083454,\n \"partition_id\": \"34k34k3-ea16-438b-81ea-c2e4b296051b:appointment.followup_reminder_instant\",\n \"transaction_id\": \"34k34k3-ea16-438b-81ea-c2e4b296051b:appointment.followup_reminder_instant:1741677083454\",\n \"data\": {\n \"appointment_id\": \"34k34k3-ea16-438b-81ea-c2e4b296051b\",\n \"doctor_id\": \"23532432142\",\n \"patient_id\": \"62342343\",\n \"clinic_id\": \"c-dsjfkj23kj3jrfdf\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{partner_host}/registered_url_for_appointment_followup_reminder_instant_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 \"business_id\": \"b-23535342\",\n \"event\": \"appointment.followup_reminder_instant\",\n \"event_time\": 1741677083454,\n \"partition_id\": \"34k34k3-ea16-438b-81ea-c2e4b296051b:appointment.followup_reminder_instant\",\n \"transaction_id\": \"34k34k3-ea16-438b-81ea-c2e4b296051b:appointment.followup_reminder_instant:1741677083454\",\n \"data\": {\n \"appointment_id\": \"34k34k3-ea16-438b-81ea-c2e4b296051b\",\n \"doctor_id\": \"23532432142\",\n \"patient_id\": \"62342343\",\n \"clinic_id\": \"c-dsjfkj23kj3jrfdf\"\n }\n}"
response = http.request(request)
puts response.read_bodyFollow-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
curl --request POST \
--url https://{partner_host}/registered_url_for_appointment_followup_reminder_instant_webhook_events \
--header 'Content-Type: application/json' \
--data '
{
"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"
}
}
'import requests
url = "https://{partner_host}/registered_url_for_appointment_followup_reminder_instant_webhook_events"
payload = {
"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"
}
}
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({
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'
}
})
};
fetch('https://{partner_host}/registered_url_for_appointment_followup_reminder_instant_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_appointment_followup_reminder_instant_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([
'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'
]
]),
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_appointment_followup_reminder_instant_webhook_events"
payload := strings.NewReader("{\n \"business_id\": \"b-23535342\",\n \"event\": \"appointment.followup_reminder_instant\",\n \"event_time\": 1741677083454,\n \"partition_id\": \"34k34k3-ea16-438b-81ea-c2e4b296051b:appointment.followup_reminder_instant\",\n \"transaction_id\": \"34k34k3-ea16-438b-81ea-c2e4b296051b:appointment.followup_reminder_instant:1741677083454\",\n \"data\": {\n \"appointment_id\": \"34k34k3-ea16-438b-81ea-c2e4b296051b\",\n \"doctor_id\": \"23532432142\",\n \"patient_id\": \"62342343\",\n \"clinic_id\": \"c-dsjfkj23kj3jrfdf\"\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_appointment_followup_reminder_instant_webhook_events")
.header("Content-Type", "application/json")
.body("{\n \"business_id\": \"b-23535342\",\n \"event\": \"appointment.followup_reminder_instant\",\n \"event_time\": 1741677083454,\n \"partition_id\": \"34k34k3-ea16-438b-81ea-c2e4b296051b:appointment.followup_reminder_instant\",\n \"transaction_id\": \"34k34k3-ea16-438b-81ea-c2e4b296051b:appointment.followup_reminder_instant:1741677083454\",\n \"data\": {\n \"appointment_id\": \"34k34k3-ea16-438b-81ea-c2e4b296051b\",\n \"doctor_id\": \"23532432142\",\n \"patient_id\": \"62342343\",\n \"clinic_id\": \"c-dsjfkj23kj3jrfdf\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{partner_host}/registered_url_for_appointment_followup_reminder_instant_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 \"business_id\": \"b-23535342\",\n \"event\": \"appointment.followup_reminder_instant\",\n \"event_time\": 1741677083454,\n \"partition_id\": \"34k34k3-ea16-438b-81ea-c2e4b296051b:appointment.followup_reminder_instant\",\n \"transaction_id\": \"34k34k3-ea16-438b-81ea-c2e4b296051b:appointment.followup_reminder_instant:1741677083454\",\n \"data\": {\n \"appointment_id\": \"34k34k3-ea16-438b-81ea-c2e4b296051b\",\n \"doctor_id\": \"23532432142\",\n \"patient_id\": \"62342343\",\n \"clinic_id\": \"c-dsjfkj23kj3jrfdf\"\n }\n}"
response = http.request(request)
puts response.read_bodyBody
Business ID for the appointment
"b-23535342"
Type of event
"appointment.followup_reminder_instant"
Event occurrence timestamp
1741677083454
Partition identifier for the event
"34k34k3-ea16-438b-81ea-c2e4b296051b:appointment.followup_reminder_instant"
Unique transaction identifier for the event
"34k34k3-ea16-438b-81ea-c2e4b296051b:appointment.followup_reminder_instant:1741677083454"
Show child attributes
Show child attributes
Response
Was this page helpful?

