Create appointment

curl --request POST \
  --url https://{partner_host}/registered_url_for_add_appointment_events \
  --header 'Content-Type: application/json' \
  --data '
{
  "event": "appointment.created",
  "event_time": 1730189586,
  "timestamp": 1730189586,
  "client_id": "67978400352a61001d64e9fb",
  "business_id": "174159057718553",
  "data": {
    "appointment_id": "api-abb67007-1e53-4f0f-b428-a4bc025468a4",
    "partner_appointment_id": "67ce9032abfba8001d17ddd2",
    "doctor_id": "174159057723920",
    "partner_doctor_id": "test-doc-123",
    "patient_id": "174678912588458",
    "partner_patient_id": "174678912588458",
    "clinic_id": "67978400352a61001d64e9fb",
    "partner_clinic_id": "CL04",
    "status": "BK",
    "action": "created",
    "created_at": 1730189586,
    "modified_at": 1730189586,
    "partner_meta": {
      "key1": "value1"
    },
    "sa_ids": [
      "sa_25061014072610653"
    ],
    "custom_attributes": {
      "label": [
        "vital_submitted"
      ]
    }
  },
  "service": "appointment",
  "transaction_id": "8y3458734657"
}
'

Appointment Events

Create appointment

When an appointment is created, 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 created, this will be appointment.created.

• 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_add_appointment_events

Create appointment

curl --request POST \
  --url https://{partner_host}/registered_url_for_add_appointment_events \
  --header 'Content-Type: application/json' \
  --data '
{
  "event": "appointment.created",
  "event_time": 1730189586,
  "timestamp": 1730189586,
  "client_id": "67978400352a61001d64e9fb",
  "business_id": "174159057718553",
  "data": {
    "appointment_id": "api-abb67007-1e53-4f0f-b428-a4bc025468a4",
    "partner_appointment_id": "67ce9032abfba8001d17ddd2",
    "doctor_id": "174159057723920",
    "partner_doctor_id": "test-doc-123",
    "patient_id": "174678912588458",
    "partner_patient_id": "174678912588458",
    "clinic_id": "67978400352a61001d64e9fb",
    "partner_clinic_id": "CL04",
    "status": "BK",
    "action": "created",
    "created_at": 1730189586,
    "modified_at": 1730189586,
    "partner_meta": {
      "key1": "value1"
    },
    "sa_ids": [
      "sa_25061014072610653"
    ],
    "custom_attributes": {
      "label": [
        "vital_submitted"
      ]
    }
  },
  "service": "appointment",
  "transaction_id": "8y3458734657"
}
'

Body

application/json

event

string

required

Type of event

Example:

"appointment.created"

event_time

integer

required

Event occured timestamp

Example:

1730189586

timestamp

integer

required

Timestamp of the event

Example:

1730189586

client_id

string

required

Client ID for the appointment

Example:

"67978400352a61001d64e9fb"

business_id

string

required

Business ID for the appointment

Example:

"174159057718553"

data

object

required

Show child attributes

data.appointment_id

string

required

Unique appointment ID

Example:

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

data.partner_appointment_id

string

required

Partner's appointment ID

Example:

"67ce9032abfba8001d17ddd2"

data.doctor_id

string

required

Identifier for the doctor in Eka

Example:

"174159057723920"

data.partner_doctor_id

string

required

Identifier for the partner’s doctor

Example:

"test-doc-123"

data.patient_id

string

required

Identifier for the patient in Eka

Example:

"174678912588458"

data.partner_patient_id

string

required

Identifier for the partner’s patient

Example:

"174678912588458"

data.clinic_id

string

required

Identifier for the clinic in Eka

Example:

"67978400352a61001d64e9fb"

data.partner_clinic_id

string

required

Identifier for the partner’s clinic

Example:

"CL04"

data.status

string

required

Status of the appointment

Example:

"BK"

data.action

string

required

Action performed

Example:

"created"

data.created_at

integer

required

Creation timestamp

Example:

1730189586

data.modified_at

integer

required

Modification timestamp

Example:

1730189586

data.partner_meta

object

required

Partner-specific metadata

Show child attributes

data.partner_meta.key1

string

Example:

"value1"

data.sa_ids

string[]

required

List of SA IDs

Example:

["sa_25061014072610653"]

data.custom_attributes

object

Custom attributes for the event

Show child attributes

data.custom_attributes.label

string[]

Example:

["vital_submitted"]

service

string

Type of serivce

Example:

"appointment"

transaction_id

string

Transaction ID for the appointment

Example:

"8y3458734657"

Response

200 - undefined

Send Notification Update appointment

⌘I

Authorization

End-to-End Encryption

Connect

HealthAI

Medical Database

General Tools

Doctor Tool

ABDM Connect

Medical Knowledge-bases

Medical Records

User App

Create appointment

Body

Response