v1

latestOpenAPI 3.0.32026-07-26229361630.0 KB

Prescription Webhooks

Prescription Created Event

When a prescription is created or modified, a webhook event is sent to registered webhooks with details about the prescription, including the prescription ID, visit ID, doctor ID, patient ID, and event type.

The receiver can then use the prescription_id from webhook events to retrieve the details of a specific prescription by calling the prescription API.

post/registered_url_for_prescription_events

Request body

event'prescription.created' | 'prescription.updated' required

event_timeinteger required

Event occured timestamp

timestampinteger required

Timestamp of the event

client_idstring required

Client ID for the appointment

business_idstring required

Business ID for the appointment

Example request

{
  "event_time": 1730189586,
  "timestamp": 1730189586,
  "client_id": "67978400352a61001d64e9fb",
  "business_id": "174159057718553",
  "data": {
    "prescription_id": "{{prescription_id}}",
    "doctor_id": "174159057723920",
    "partner_doctor_id": "test-doc-123",
    "patient_id": "174678912588458",
    "current_version": "2",
    "previous_version": "1",
    "prescription_url": "https://prescription-store-s3.eka.care/P-DW-sam123ple.pdf",
    "prescription_url_print": "https://prescription-store-s3.eka.care/P-DW-sam123ple-print.pdf",
    "partner_patient_id": "77237637763817-17",
    "clinic_id": "67978400352a61001d64e9fb",
    "partner_clinic_id": "CL04",
    "partner_appointment_id": "67ce9032abfba8001d17ddd2",
    "created_at": 1730189586,
    "modified_at": 1730189586,
    "partner_meta": {
      "key1": "{{value1}}"
    }
  }
}