Skip to main content

Developers

Open Admin → Developers in the client portal to connect Dimmi to your HRIS or other systems.

You manage two things here:

  1. API keys — credentials your systems use to call the Public API
  2. Webhooks — HTTPS URLs Dimmi calls when something important happens

Partners do not create or edit webhooks via the API key. Webhook URLs and event subscriptions are configured only in this Developers screen (by a signed-in admin). Your integration receives signed HTTP deliveries and can verify them — see Webhooks.

API keys​

  1. Create a key and give it a clear name (for example “Workday production”).
  2. Choose scopes — typically cases:read / cases:write, people:read, and document scopes as needed.
  3. Copy the secret when it is shown — Dimmi only displays it once.
  4. Call the API with Authorization: Bearer dk_live_<key_id>.<secret> (see Authentication).

Keys are limited to your organisation. They can only see and start work for your people and cases.

Useful partner operations:

  • List and create cases (including short-term visitors via POST /cases/short-term)
  • List people — each person includes nested permits, certificates, and cases so you can reconstruct journeys without separate assignment or permit list endpoints
  • Read and upload documents on cases

Full contract: OpenAPI reference and API getting started.

Webhooks​

  1. Register an HTTPS endpoint your systems own.
  2. Subscribe to events you care about (case created, status changed, permit granted, certificate granted, monitoring alerts, and others listed in the webhook guide).
  3. Store the signing secret Dimmi shows and verify each delivery’s signature.

Use the deliveries list on Developers when troubleshooting missed or failed calls.