Doctor Webhooks

Google Review Manual Event

When a Google review request is manually triggered through doctor platform, a webhook is sent to the registered endpoint containing the Appointment ID, Doctor ID, Patient ID, Clinic ID, and Google review link. The receiving system can use these details to update or manage Google review information as needed.

post/registered_url_for_google_review_manual_events

Request

Base URL
https://api.eka.care
Auth
none required
TypeScript
https://skmtc.dev/eka/apis/eka-developer-apis/docs/registered_url_for_google_review_manual_events/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

event'google_review.request_manual' required

Type of event

event_timeinteger required

Event occurred timestamp

timestampinteger required

Timestamp of the event

client_idstring required

Client ID for the schedule

business_idstring required

Business ID for the schedule

Example request

{
  "event": "google_review.request_manual",
  "event_time": 1730189586,
  "timestamp": 1730189586,
  "client_id": "67978400352a61001d64e9fb",
  "business_id": "174159057718553",
  "data": {
    "appointment_id": "apt-67890",
    "doctor_id": "doc-abc123",
    "patient_id": "patient-xyz789",
    "clinic_id": "clinic-def456",
    "google_review_link": "https://g.page/r/example-review-link/review"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.