v1
latestOpenAPI 3.0.32026-07-26229361630.0 KBIPD Admission Event
When an event occurs against an IPD admission (such as a clearance, stage change or other workflow action), a webhook event is sent to registered webhooks describing the action that was performed.
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_events.created or ipd_admissions_events.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 admission event.
• kind: string - The kind of event (e.g. CLEARANCE).
• by: object - The actor who performed the action.
• to: string - The resulting state of the action (e.g. COMPLETED).
Example Webhook Request
Endpoint: https://your-registered-webhook-url.com
Method: POST
Request body
Example request
{
"service": "ipd",
"event": "ipd_admissions_events.created",
"event_time": 1782811749,
"transaction_id": "93cfa0eb-f9af-4391-afd7-7f8409e45c22",
"timestamp": 1782811749,
"business_id": "7175620245483777",
"client_id": "EC_1777984421469",
"data": {
"at": "2026-06-30 09:29:02.364000+00:00",
"by": {
"id": "175620245502842",
"name": "Dr Imtiyaz m,"
},
"clearance_type": "pharmacy",
"id": "93cfa0eb-f9af-4391-afd7-7f8409e45c22",
"kind": "CLEARANCE",
"to": "COMPLETED"
}
}