v1

latestOpenAPI 3.0.32026-07-26229361630.0 KB
IPD Webhooks

IPD Admission Clearance

When a clearance is created or updated against an IPD admission (for example a pharmacy, billing or housekeeping clearance), a webhook event is sent to registered webhooks with the clearance status and details.

Field Definitions

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

event: string - The type of event. This will be ipd_admissions_clearances.created or ipd_admissions_clearances.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 details about the clearance.

type: string - The type of clearance (e.g. pharmacy).

status: string - Status of the clearance (e.g. COMPLETED).

completed_by: object - The actor who completed the clearance.

Example Webhook Request

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

Method: POST

post/registered_url_for_ipd_admissions_clearances_events

Request body

servicestring required

Type of service

event'ipd_admissions_clearances.created' | 'ipd_admissions_clearances.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_clearances.created",
  "event_time": 1782811750,
  "transaction_id": "ipd/7175620245483777/admissions/6909b0faba49e0b2f147cf58/clearances/pharmacy",
  "timestamp": 1782811750,
  "business_id": "7175620245483777",
  "client_id": "EC_1777984421469",
  "data": {
    "completed_at": "2026-06-30 09:29:02.236000+00:00",
    "completed_by": {
      "id": "175620245502842",
      "name": "Dr Imtiyaz m,"
    },
    "status": "COMPLETED",
    "type": "pharmacy",
    "updated_at": "2026-06-30 09:29:02.236000+00:00"
  }
}