curl --request POST \
--url https://{partner_host}/registered_url_for_appointment_reminder_instant_webhook_events \
--header 'Content-Type: application/json' \
--data '
{
"business_id": "b-23535342",
"event": "appointment.reminder_instant",
"event_time": 1741677083454,
"partition_id": "34k34k3-ea16-438b-81ea-c2e4b296051b:appointment.reminder_instant",
"transaction_id": "34k34k3-ea16-438b-81ea-c2e4b296051b:appointment.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_reminder_instant_webhook_events"
payload = {
"business_id": "b-23535342",
"event": "appointment.reminder_instant",
"event_time": 1741677083454,
"partition_id": "34k34k3-ea16-438b-81ea-c2e4b296051b:appointment.reminder_instant",
"transaction_id": "34k34k3-ea16-438b-81ea-c2e4b296051b:appointment.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.reminder_instant',
event_time: 1741677083454,
partition_id: '34k34k3-ea16-438b-81ea-c2e4b296051b:appointment.reminder_instant',
transaction_id: '34k34k3-ea16-438b-81ea-c2e4b296051b:appointment.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_reminder_instant_webhook_events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://{partner_host}/registered_url_for_appointment_reminder_instant_webhook_events")
.header("Content-Type", "application/json")
.body("{\n \"business_id\": \"b-23535342\",\n \"event\": \"appointment.reminder_instant\",\n \"event_time\": 1741677083454,\n \"partition_id\": \"34k34k3-ea16-438b-81ea-c2e4b296051b:appointment.reminder_instant\",\n \"transaction_id\": \"34k34k3-ea16-438b-81ea-c2e4b296051b:appointment.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();using RestSharp;
var options = new RestClientOptions("https://{partner_host}/registered_url_for_appointment_reminder_instant_webhook_events");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"business_id\": \"b-23535342\",\n \"event\": \"appointment.reminder_instant\",\n \"event_time\": 1741677083454,\n \"partition_id\": \"34k34k3-ea16-438b-81ea-c2e4b296051b:appointment.reminder_instant\",\n \"transaction_id\": \"34k34k3-ea16-438b-81ea-c2e4b296051b:appointment.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}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
require 'uri'
require 'net/http'
url = URI("https://{partner_host}/registered_url_for_appointment_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.reminder_instant\",\n \"event_time\": 1741677083454,\n \"partition_id\": \"34k34k3-ea16-438b-81ea-c2e4b296051b:appointment.reminder_instant\",\n \"transaction_id\": \"34k34k3-ea16-438b-81ea-c2e4b296051b:appointment.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_bodyAppointment Reminder (Instant)
This webhook is triggered to send an instant reminder for an upcoming appointment. Unlike the standard reminder which is scheduled in advance, this reminder event is sent immediately. The receiving system can use this to trigger instant alerts to the patient or doctor.
Field Definitions
• event: string - The type of event. For instant appointment reminders, this will be appointment.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_reminder_instant_webhook_events \
--header 'Content-Type: application/json' \
--data '
{
"business_id": "b-23535342",
"event": "appointment.reminder_instant",
"event_time": 1741677083454,
"partition_id": "34k34k3-ea16-438b-81ea-c2e4b296051b:appointment.reminder_instant",
"transaction_id": "34k34k3-ea16-438b-81ea-c2e4b296051b:appointment.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_reminder_instant_webhook_events"
payload = {
"business_id": "b-23535342",
"event": "appointment.reminder_instant",
"event_time": 1741677083454,
"partition_id": "34k34k3-ea16-438b-81ea-c2e4b296051b:appointment.reminder_instant",
"transaction_id": "34k34k3-ea16-438b-81ea-c2e4b296051b:appointment.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.reminder_instant',
event_time: 1741677083454,
partition_id: '34k34k3-ea16-438b-81ea-c2e4b296051b:appointment.reminder_instant',
transaction_id: '34k34k3-ea16-438b-81ea-c2e4b296051b:appointment.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_reminder_instant_webhook_events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://{partner_host}/registered_url_for_appointment_reminder_instant_webhook_events")
.header("Content-Type", "application/json")
.body("{\n \"business_id\": \"b-23535342\",\n \"event\": \"appointment.reminder_instant\",\n \"event_time\": 1741677083454,\n \"partition_id\": \"34k34k3-ea16-438b-81ea-c2e4b296051b:appointment.reminder_instant\",\n \"transaction_id\": \"34k34k3-ea16-438b-81ea-c2e4b296051b:appointment.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();using RestSharp;
var options = new RestClientOptions("https://{partner_host}/registered_url_for_appointment_reminder_instant_webhook_events");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"business_id\": \"b-23535342\",\n \"event\": \"appointment.reminder_instant\",\n \"event_time\": 1741677083454,\n \"partition_id\": \"34k34k3-ea16-438b-81ea-c2e4b296051b:appointment.reminder_instant\",\n \"transaction_id\": \"34k34k3-ea16-438b-81ea-c2e4b296051b:appointment.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}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
require 'uri'
require 'net/http'
url = URI("https://{partner_host}/registered_url_for_appointment_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.reminder_instant\",\n \"event_time\": 1741677083454,\n \"partition_id\": \"34k34k3-ea16-438b-81ea-c2e4b296051b:appointment.reminder_instant\",\n \"transaction_id\": \"34k34k3-ea16-438b-81ea-c2e4b296051b:appointment.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
Response
Was this page helpful?

