API RESOURCE

Webhooks

As events occur in your clinic, a signed notification is sent to your registered address; you keep your own system instantly up to date.

Early Access All API

Endpoints

3 endpoint

Endpoints for this resource. Every endpoint is scoped to the clinic data the API key is bound to; write endpoints support the Idempotency-Key header.

GET /v1/webhooks Lists registered webhook subscriptions admin

POST /v1/webhooks Registers a webhook for event notifications admin

DELETE /v1/webhooks/{id} Deletes the webhook subscription admin

Example Usage

Register webhook

Request

curl -X POST https://api.udentiva.com/v1/webhooks \
  -H "Authorization: Bearer udk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://siz.example/hook","events":["payment.created"]}'

Response

HTTP/1.1 201 Created
{
  "id": "wh-1",
  "url": "https://siz.example/hook",
  "events": ["payment.created"],
  "secret": "whsec_xxx"
}

Security in this resource

Security isn't a feature, it's the architecture itself. The guarantees that apply to this resource:

Every notification is signed with a shared secret key (HMAC); by verifying the signature you confirm that the request truly comes from UDENTIVA.

Redelivery-safe: every event has a unique identifier; you can deduplicate duplicate deliveries by the identifier (idempotent consumption).

Webhook subscriptions are isolated to your clinic; you receive only your own events.

Full security model →

Error Format

Errors are returned in a consistent envelope; the code is for the machine, the message for the user. Internal error/stack is never leaked.

{
  "error": {
    "code": "validation_failed",
    "message": "Invalid field: email"
  }
}

Other Resources

患者予約とカレンダー Odontogram & Treatment Collections & Finance 在庫 Imaging ラボ Lead & CRM 医療ツーリズム Reporting & BI Data Transfer (Export API)

Want early access?

Be the first to know when the API opens.

お問い合わせ