Authorization

Connect

Webhooks

General Tools

Self Assessments
Medical Document Parsing
Medical Speech Understanding

Doctor Tool

Actors
Instructions
Patient Registration API
Doctor and clinic API
Appointment API
Payments API
Prescription API
Notify
Webhooks
- Appointment
  - POST
    Appointment Events
- Prescription
- Doctor

ABDM Connect

Create and Login
User Session
Patient Requests
Consents
Care Contexts
Providers
Profile
Scan & Share
Errors

Medical Records

Create
Read
Update
Delete
Webhooks

User App

Notifications
Vital
Webhooks
Privacy

Release Notes

ABDM Connect

Appointment

Appointment Events

When an appointment is created/modified or completed, a webhook event is sent to registered webhooks with details about the appointment, including the appointment ID, status, doctor ID, patient ID, and event type.

Field Definitions

• event: string - The type of resource for which event is generated. For appointments, this will be appointment.

• data: object - Contains detailed information about the appointment event.

• appointment_id: string - Unique identifier for the appointment.

• doctor_id: string - Unique identifier for the doctor.

• patient_id: string - Unique identifier for the patient.

• status: string - Status of the appointment. Possible values can be

“BK” (Booked),
“OG” (Ongoing),
“CM” (Completed with Prescription),
“CMNP” (Completed without Prescription),
“CN” (Cancelled).

• action: string - Current action for the appointment. Possible values can be

created
modified
completed

• partner_meta: key value pair specified by partner while creating appointment.

• timestamp: string (ISO 8601) - The date and time when the event occurred.

• custom_attibutes: complete set of custom attributes(inclusing tags and labels) defined against this appointment. occurred.

Example Webhook Request

Endpoint: https://your-registered-webhook-url.com

Method: POST

POST

registered_url_for_appointment_events

curl --request POST \
  --url https:///%7B{partner_host}%7D/registered_url_for_appointment_events \
  --header 'Content-Type: application/json' \
  --data '{
  "event": "appointment.created",
  "event_time": 1730189586,
  "timestamp": 1730189586,
  "client_id": "{{business_id}}",
  "business_id": "{{business_id}}",
  "data": {
    "appointment_id": "{{appointment_id}}",
    "partner_appointment_id": "{{partner_appointment_id}}",
    "doctor_id": "{{doctor_id}}",
    "partner_doctor_id": "{{partner_doctor_id}}",
    "patient_id": "{{patient_id}}",
    "partner_patient_id": "{{partner_patient_id}}",
    "clinic_id": "{{clinic_id}}",
    "partner_clinic_id": "{{partner_clinic_id}}",
    "status": "BK",
    "action": "created",
    "created_at": 1730189586,
    "modified_at": 1730189586,
    "custom_attributes": {
      "label": [
        "vital_submitted"
      ]
    },
    "partner_meta": {
      "key1": "value1"
    }
  }
}'

Body

application/json

event

string

required

Type of event

event_time

integer

required

Event occured timestamp

timestamp

integer

required

Timestamp of the event

client_id

string

required

Client ID for the appointment

business_id

string

required

Business ID for the appointment

data

object

required

Send Notification Prescription Events

curl --request POST \
  --url https:///%7B{partner_host}%7D/registered_url_for_appointment_events \
  --header 'Content-Type: application/json' \
  --data '{
  "event": "appointment.created",
  "event_time": 1730189586,
  "timestamp": 1730189586,
  "client_id": "{{business_id}}",
  "business_id": "{{business_id}}",
  "data": {
    "appointment_id": "{{appointment_id}}",
    "partner_appointment_id": "{{partner_appointment_id}}",
    "doctor_id": "{{doctor_id}}",
    "partner_doctor_id": "{{partner_doctor_id}}",
    "patient_id": "{{patient_id}}",
    "partner_patient_id": "{{partner_patient_id}}",
    "clinic_id": "{{clinic_id}}",
    "partner_clinic_id": "{{partner_clinic_id}}",
    "status": "BK",
    "action": "created",
    "created_at": 1730189586,
    "modified_at": 1730189586,
    "custom_attributes": {
      "label": [
        "vital_submitted"
      ]
    },
    "partner_meta": {
      "key1": "value1"
    }
  }
}'