v1

latestOpenAPI 3.0.32026-07-26229361630.0 KB

Prescription Webhooks

Prescription Communication Event

This webhook is triggered when a user performs an on-demand "Send Rx" action from the tool, sharing a prescription with the patient. The registered endpoint receives details about the prescription that was communicated, including the prescription ID, prescription URL, doctor, patient and appointment information.

The receiver can use the prescription_id or prescription_url from the webhook event to retrieve or render the shared prescription.

post/registered_url_for_prescription_communication_events

Request body

servicestring required

Service that emitted the event

event'prescription.communication' required

Type of event

event_timeinteger required

Event occurred timestamp in milliseconds

timestampinteger

Timestamp of the event

transaction_idstring required

Unique transaction identifier for the event

business_idstring required

Business ID for the prescription

client_idstring

Client ID for the prescription

Example request

{
  "service": "prescription",
  "event_time": 1782207271381,
  "transaction_id": "2f924bba-e055-4b45-8b7d-f8e1259ec01a",
  "business_id": "7177796085787388",
  "data": {
    "actor_oid": "177796085790372",
    "appointment_id": "d-149c99c8-9f02-4300-8528-d602da6311ad",
    "clinic_id": "c-603d3b6ed2d1496ca0fe6d82",
    "doc_name": {
      "salutation": "Dr.",
      "first_name": "Shreya",
      "last_name": "Gupta"
    },
    "doctor_id": "do1777976297512",
    "patient_id": "178153131932085",
    "patient_name": {
      "first_name": "test"
    },
    "prescription_id": "P-DW-198A8DA9-6B88-5A88-9C38-2407352F28E9",
    "prescription_url": "https://prescription-store-s3.eka.care/P-DW-198A8DA9-6B88-5A88-9C38-2407352F28E9.pdf?v=1782207271381"
  }
}