Prerequisites
The connector should already be set up, with a Connector Profile and a Linked Account. See Getting Started on the Eka Care connector page.Automatic subscription
StackOne creates and manages the Eka Care webhook subscription automatically when the account is connected, and deletes it when the account is disconnected. There is nothing to configure in Eka Care.
- The subscription is registered for exactly the events you enable in StackOne and is re-created when the selection changes.
- Eka Care delivers every event in the workspace to every subscription in it, so each connected account receives all events for its workspace, whichever API client made the change.
Available webhook events
The following Eka Care events can be enabled. Only events selected in StackOne are included in the subscription; Eka Care does not deliver events that are not subscribed.
Appointment events
Events related to appointments, reminders and video consultations.
- Appointment Created (
appointment.created) — Fired when an appointment is booked - Appointment Updated (
appointment.updated) — Fired when an appointment is modified - Appointment Status Changed (
appointment.statuschange) — Fired when an appointment’s status changes - Appointment Assessment Taken (
appointment.assessments.taken) — Fired when an assessment is recorded on an appointment - Doctor Joined Video Call (
appointment.tele.dr_joined) — Fired when the doctor joins a video consultation - Appointment Reminder (
appointment.reminder_instant) — Fired when an instant appointment reminder is sent - Follow-up Reminder (
appointment.followup_reminder_instant) — Fired when an instant follow-up reminder is sent - Vaccination Reminder (
vaccination.reminder) — Fired when a vaccination reminder is due for a patient
Prescription events
Events related to prescriptions.
- Prescription Created (
prescription.created) — Fired when a prescription is created - Prescription Updated (
prescription.updated) — Fired when a prescription is updated - Prescription Shared (
prescription.communication) — Fired when a prescription is shared with the patient
Doctor events
Events related to doctor availability, Google review requests and consent forms.
- Doctor Started Practice (
schedule.start_practice) — Fired when a doctor starts practice - Doctor Stopped Practice (
schedule.stop_practice) — Fired when a doctor stops practice - Doctor Available for Consultation (
schedule.available_for_consultation) — Fired when a doctor becomes available for consultation - Google Review Requested (
google_review.request) — Fired when an automatic Google review request is sent to a patient - Google Review Requested Manually (
google_review.request_manual) — Fired when a doctor manually sends a Google review request - Consent Form Created (
mcert.created) — Fired when a consent form or medical certificate is created - Consent Form Updated (
mcert.updated) — Fired when a consent form or medical certificate is updated
Receipt events
Events related to receipts and payment links.
- Receipt Created (
receipt.created) — Fired when a receipt is created - Receipt Updated (
receipt.updated) — Fired when a receipt is updated - Receipt Deleted (
receipt.deleted) — Fired when a receipt is deleted - Payment Link Requested (
receipt_payment.requested) — Fired when a payment link is requested for an appointment
IPD admission events
Events related to inpatient (IPD) admissions, their events, discharge clearances and estimates.
- IPD Admission Created (
ipd_admissions.created) — Fired when an IPD admission is created - IPD Admission Updated (
ipd_admissions.updated) — Fired when an IPD admission is updated - IPD Admission Event Recorded (
ipd_admissions_events.created) — Fired when an event is recorded on an IPD admission - IPD Admission Event Updated (
ipd_admissions_events.updated) — Fired when an IPD admission event is updated - IPD Discharge Clearance Created (
ipd_admissions_clearances.created) — Fired when a discharge clearance is created on an IPD admission - IPD Discharge Clearance Updated (
ipd_admissions_clearances.updated) — Fired when a discharge clearance is updated - IPD Admission Estimate Created (
ipd_admissions_estimates.created) — Fired when a cost estimate is added to an IPD admission - IPD Admission Estimate Updated (
ipd_admissions_estimates.updated) — Fired when an IPD admission estimate is updated
Delivery format
Details of how Eka Care delivers events to StackOne.
JSON payloads
Eka Care sends one event per HTTP POST, with a JSON body containing event (for example appointment.created), event_time (epoch seconds), transaction_id, business_id, client_id and the resource under data.
Several events per change
A single change can produce more than one event. For example, booking an appointment sends appointment.created, appointment.updated and appointment.statuschange together, with the same transaction_id and event_time. All three are delivered, with the same event ID and a different event type. The event ID is the record ID (for example the appointment ID), so it can be used to fetch the record. Events whose record Eka cannot return through its API (receipts, certificates, IPD admission events, estimates and clearances) use UNKNOWN.