---
title: "IPD Admission Clearance"
method: POST
path: "/registered_url_for_ipd_admissions_clearances_events"
tags: ["IPD Webhooks"]
---

# IPD Admission Clearance

`POST /registered_url_for_ipd_admissions_clearances_events`

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](https://your-registered-webhook-url.com)

**Method:** POST

## Request body

- object
  - `service` string, required — Type of service
  - `event` 'ipd_admissions_clearances.created' | 'ipd_admissions_clearances.updated', required — Type of event
  - `event_time` integer, required — Event occurred timestamp
  - `transaction_id` string — Unique transaction identifier for the event
  - `timestamp` integer, required — Timestamp of the event
  - `business_id` string, required — Business ID for the admission
  - `client_id` string — Client ID for the admission
  - `data` object, required
    - `completed_at` string — Timestamp when the clearance was completed
    - `completed_by` object — Actor who completed the clearance
      - `id` string — Actor identifier
      - `name` string — Actor name
    - `status` string, required — Status of the clearance
    - `type` string, required — Type of clearance
    - `updated_at` string — Last update timestamp

## Response `200`

---

[API](https://skmtc.dev/eka/apis/eka-developer-apis.md) · [All operations](https://skmtc.dev/eka/apis/eka-developer-apis/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/eka/eka-developer-apis/revisions/9ea23456f722/schema)