Skip to content

Integrations and API

With an API key you connect your practice management system to The Dutch Dataroom; with webhooks you get a message when something happens. Both are under Office administration → Integrations.

  1. Open Office administration → Integrations.
  2. Choose Create key.
  3. Give the key a recognisable name (for example practice system link).
  4. Choose the scopes: which parts may this key read or write?
  5. Set the validity in days.
  6. Copy the key immediately: you see it once.

The key then works without a further login step. Keep it in the configuration of your system, not in a document or a chat.

A key never gets more permissions than the scopes you choose. Choose the smallest set that works:

Scope What it allows
Read datarooms Read the list of datarooms and their set-up
Manage datarooms Create and change datarooms
Read documents Read the index and document details
Upload documents Add files
Download documents Retrieve originals where that is allowed

A key expires on the date you set. You can also revoke it immediately. Revoke a key when a link stops or when you suspect it has leaked; create a new one afterwards.

A webhook sends a message to your system on an event: an upload, a new request, a signed document. Every call is signed with a part you can verify with the secret of the endpoint, so that your system knows for sure that the message comes from us. Per endpoint you see which events were delivered and which failed.

If a delivery fails, it stays visible with its status. That way you see at once whether your system missed something; you do not have to search your own logs.

The technical documentation is publicly available at /api-docs, with the scopes, the signing of webhooks and the MCP link for AI assistants. The OpenAPI document itself is at /api-docs/openapi.json and is always identical to the version that is offered.

Public API documentation with scopes, webhook signing and the MCP link
The API documentation at /api-docs: scopes, webhook signing and the MCP link.