v1

latestOpenAPI 3.0.32026-07-26229361630.0 KB
IPD Webhooks

IPD Admission

When an IPD (In-Patient Department) admission is created or updated, a webhook event is sent to registered webhooks with the full admission details, including the patient, attending doctor, facility, department, bed, category, rate plan, insurance and billing information.

Field Definitions

service: string - The type of service. For IPD events, this will be ipd.

event: string - The type of event. For admissions, this will be ipd_admissions.created or ipd_admissions.updated.

event_time: integer - Event occurrence timestamp (epoch seconds).

transaction_id: string - Unique transaction identifier for the event.

timestamp: integer - Timestamp of the event (epoch seconds).

business_id: string - The eka ID of the business.

client_id: string - Client ID associated with the event.

data: object - Contains detailed information about the admission.

id / ipid: string - Unique identifiers for the admission.

stage / status: string - Current stage and status of the admission (e.g. AD, BED_ASSIGNED).

patient / doc / attendee: object - Patient, attending doctor and attendee details.

facility / department / bed / category: Location and allocation details for the admission.

rateplan / insurance / totalbilled / totalpaid: Billing, package and insurance details.

Example Webhook Request

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

Method: POST

post/registered_url_for_ipd_admissions_events

Request body

servicestring required

Type of service

event'ipd_admissions.created' | 'ipd_admissions.updated' required

Type of event

event_timeinteger required

Event occurred timestamp

transaction_idstring

Unique transaction identifier for the event

timestampinteger required

Timestamp of the event

business_idstring required

Business ID for the admission

client_idstring

Client ID for the admission

Example request

{
  "service": "ipd",
  "event": "ipd_admissions.created",
  "event_time": 1782804321,
  "transaction_id": "a9f54d1a-4080-4eec-9db1-ccbfc1771a5d",
  "timestamp": 1782804321,
  "business_id": "7175620245483777",
  "client_id": "EC_1777984421469",
  "data": {
    "actor_oid": "175620245502842",
    "admission_date": "2026-06-30 07:24:21.985000+00:00",
    "attendee": {
      "id": "attendee-id",
      "name": "Sachin New",
      "phone": {
        "c": "+91",
        "n": "8765434565"
      },
      "relation": {
        "id": "sm-1034094231",
        "label": "Father"
      }
    },
    "bed": "6a42477e282b241a943db696",
    "bid": "7175620245483777",
    "category": {
      "id": "68e7622e24b43838dd2e7af2",
      "name": "VIP"
    },
    "created_at": "2026-06-30 07:25:18.779000+00:00",
    "date": "2026-06-30 07:24:21.985000+00:00",
    "department": {
      "id": "surgery",
      "name": "Surgery"
    },
    "doc": {
      "id": "175620245502842",
      "name": "Imtiyaz's m,"
    },
    "docid": "175620245502842",
    "duration": {
      "unit": "days",
      "value": 5
    },
    "facility": {
      "id": "68ad85d786ddd9001d409348",
      "name": "Imtiyaz"
    },
    "facilityid": "68ad85d786ddd9001d409348",
    "id": "a9f54d1a-4080-4eec-9db1-ccbfc1771a5d",
    "insurance": {
      "coverage_type": [
        "ipd"
      ],
      "payment_type": "cash",
      "type": "None"
    },
    "ipid": "IPD84",
    "patient": {
      "formData": [],
      "id": "177805765470391",
      "profile": {
        "personal": {
          "age": {
            "dob": "2004-05-06T00:00:00.000Z"
          },
          "gender": "Male",
          "name": "sachin Jaiswal",
          "phone": {
            "c": "+91",
            "n": "9131157898"
          }
        }
      },
      "uuid": "CS-7175620245483777-177805765470391"
    },
    "pid": "177805765470391",
    "procedures": [],
    "rateplan": {
      "id": "698b01130bc0d53ade702618",
      "inclusions": [
        {
          "id": "698b0147996ddf4a5dff7790",
          "name": "Operation Charge, OT Charges, Nursing Charges, ICU Charges, Room Rent, Misc.",
          "rate": 50000
        }
      ],
      "name": "Full Treatment Package -  ₹50000"
    },
    "stage": "AD",
    "status": "BED_ASSIGNED",
    "totalbilled_updated_at": "2026-06-30 07:25:18.779000+00:00",
    "totalpaid_updated_at": "2026-06-30 07:25:18.779000+00:00",
    "updated_at": "2026-06-30 07:25:18.779000+00:00"
  }
}