Status changed

curl --request POST \
  --url https://{partner_host}/registered_url_for_status_change_events \
  --header 'Content-Type: application/json' \
  --data '
{
  "business_id": "77133577914507",
  "client_id": "",
  "event": "appointment.statuschange",
  "event_time": 1749544752,
  "timestamp": 1730189586,
  "data": {
    "appointment_id": "api-53423-GH_228766880001",
    "clinic_id": "678f4fcd4ce758001d3624ee",
    "created_at": 1749532041,
    "doctor_id": "173744358327115",
    "modified_at": 1749544752,
    "patient_id": "173986493567406",
    "status": "CM",
    "custom_attributes": {
      "label": [
        "vitals_submitted"
      ],
      "tags": [
        "paid",
        "in_consult"
      ]
    },
    "partner_appointment_id": "GH_228766880001",
    "partner_clinic_id": "CL04",
    "partner_doctor_id": "sheilly",
    "partner_meta": {
      "appointment_id": "api-abb67007-1e53-4f0f-b428-a4bc025468a4",
      "encounter_id": "228766880001",
      "facility_id": "GH"
    },
    "partner_patient_id": "MM01156831"
  },
  "service": "appointment",
  "transaction_id": "api-53423-GH_228766880001"
}
'

Appointment Events

Status changed

When status of an appointment changes, 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. Here, it will be appointment.statuschange.

• service: string - The type of service. 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_status_change_events

Status changed

curl --request POST \
  --url https://{partner_host}/registered_url_for_status_change_events \
  --header 'Content-Type: application/json' \
  --data '
{
  "business_id": "77133577914507",
  "client_id": "",
  "event": "appointment.statuschange",
  "event_time": 1749544752,
  "timestamp": 1730189586,
  "data": {
    "appointment_id": "api-53423-GH_228766880001",
    "clinic_id": "678f4fcd4ce758001d3624ee",
    "created_at": 1749532041,
    "doctor_id": "173744358327115",
    "modified_at": 1749544752,
    "patient_id": "173986493567406",
    "status": "CM",
    "custom_attributes": {
      "label": [
        "vitals_submitted"
      ],
      "tags": [
        "paid",
        "in_consult"
      ]
    },
    "partner_appointment_id": "GH_228766880001",
    "partner_clinic_id": "CL04",
    "partner_doctor_id": "sheilly",
    "partner_meta": {
      "appointment_id": "api-abb67007-1e53-4f0f-b428-a4bc025468a4",
      "encounter_id": "228766880001",
      "facility_id": "GH"
    },
    "partner_patient_id": "MM01156831"
  },
  "service": "appointment",
  "transaction_id": "api-53423-GH_228766880001"
}
'

Body

application/json

business_id

string

required

Business ID for the appointment

Example:

"77133577914507"

client_id

string

required

Client ID for the appointment

Example:

""

event

string

required

Type of event

Example:

"appointment.statuschange"

event_time

integer

required

Event occurred timestamp

Example:

1749544752

timestamp

integer

required

Timestamp of the event

Example:

1730189586

data

object

required

Show child attributes

data.appointment_id

string

required

Unique appointment ID

Example:

"api-53423-GH_228766880001"

data.clinic_id

string

required

Identifier for the clinic

Example:

"678f4fcd4ce758001d3624ee"

data.created_at

integer

required

Creation timestamp

Example:

1749532041

data.doctor_id

string

required

Identifier for the doctor

Example:

"173744358327115"

data.modified_at

integer

required

Modification timestamp

Example:

1749544752

data.patient_id

string

required

Identifier for the patient

Example:

"173986493567406"

data.status

string

required

Status of the appointment

Example:

"CM"

data.custom_attributes

object

Custom attributes for the appointment

Show child attributes

data.custom_attributes.label

string[]

Example:

["vitals_submitted"]

data.custom_attributes.tags

string[]

Example:

["paid", "in_consult"]

data.partner_appointment_id

string

Partner's appointment ID

Example:

"GH_228766880001"

data.partner_clinic_id

string

Partner’s clinic identifier

Example:

"CL04"

data.partner_doctor_id

string

Partner’s doctor identifier

Example:

"sheilly"

data.partner_meta

object

Partner-specific metadata

Show child attributes

data.partner_meta.appointment_id

string

Example:

"api-abb67007-1e53-4f0f-b428-a4bc025468a4"

data.partner_meta.encounter_id

string

Example:

"228766880001"

data.partner_meta.facility_id

string

Example:

"GH"

data.partner_patient_id

string

Partner’s patient identifier

Example:

"MM01156831"

service

string

Service related to the event

Example:

"appointment"

transaction_id

string

Transaction ID for the event

Example:

"api-53423-GH_228766880001"

Response

200 - undefined

Assessment Taken Doctor Joined Video Call

⌘I

Authorization

End-to-End Encryption

Connect

HealthAI

Medical Database

General Tools

Doctor Tool

ABDM Connect

Medical Knowledge-bases

Medical Records

User App

Status changed

Body

Response