Appointment Reminder

This webhook is triggered when a reminder is sent for an upcoming appointment. It notifies the registered endpoint with appointment details so the receiving system can take appropriate action such as sending notifications to the patient or doctor.

Field Definitions

• event: string - The type of event. For appointment reminders, this will be appointment.reminder.

• 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

POST /registered_url_for_appointment_reminder_webhook_events

Appointment Reminder

cURL

curl --request POST \
  --url https://{partner_host}/registered_url_for_appointment_reminder_webhook_events \
  --header 'Content-Type: application/json' \
  --data '
{
  "business_id": "b-23535342",
  "event": "appointment.reminder",
  "event_time": 1741677083454,
  "partition_id": "34k34k3-ea16-438b-81ea-c2e4b296051b:appointment.reminder",
  "transaction_id": "34k34k3-ea16-438b-81ea-c2e4b296051b:appointment.reminder:1741677083454",
  "data": {
    "appointment_id": "34k34k3-ea16-438b-81ea-c2e4b296051b",
    "doctor_id": "23532432142",
    "patient_id": "62342343",
    "clinic_id": "c-dsjfkj23kj3jrfdf"
  }
}
'

Body

application/json

business_id · string

Business ID for the appointment

Example:

"b-23535342"

event · string

Type of event

Example:

"appointment.reminder"

event_time · integer

Event occurrence timestamp

Example:

1741677083454

partition_id · string

Partition identifier for the event

Example:

"34k34k3-ea16-438b-81ea-c2e4b296051b:appointment.reminder"

transaction_id · string

Unique transaction identifier for the event

Example:

"34k34k3-ea16-438b-81ea-c2e4b296051b:appointment.reminder:1741677083454"

data · object

Show child attributes

Response

200 - undefined