Skip to content
Browse the docs

Administration

API and webhooks

Read and update your Nidus data from other tools with a company API key, and get signed webhooks when assets, stock, licenses and more change.

API keys

An admin turns on Public API and webhooks in Administration → Features, then creates a key on Administration → API and webhooks and chooses what it can read. The key is shown once. Send it as Authorization: Bearer nds_… to your company's own address, for example https://acme.nidus.sh/api/v1/assets.

  • GET /api/v1/assets and /api/v1/assets/{tag}: assets with status, holder, serials, cost and warranty.
  • GET /api/v1/people, /stock, /licenses, /contracts.
  • Lists take ?limit= (up to 200) and return nextCursor; pass it back as ?cursor=. ?archived=true lists archived records.
  • With Create and update assets, POST /api/v1/assets creates an asset (assetTag, name, category by name, optional serials, location, status, purchaseDate, warrantyExpires, customFields) and PATCH /api/v1/assets/{tag} changes only the fields you send. The same rules as the app apply, and changes are logged as the admin who created the key.
  • Keys are limited to 120 requests a minute. Revoke a key at any time.

SCIM provisioning

With SCIM provisioning on, create a SCIM token on Administration → API and webhooks and give your identity provider (Okta, Entra ID, OneLogin) the base URL https://<your company>.nidus.sh/scim/v2 and the token. Users it creates appear as directory people; deactivating someone disables them and removing them marks them as left, which starts offboarding when you have an auto-start template. Groups and their members are kept too and listed on that page; Nidus roles still come from your Entra group mappings.

Webhooks

Add an https URL and pick events such as asset.created, asset.assigned, asset.disposed, stock.moved or person.left. Each delivery is a JSON POST with Nidus-Event and Nidus-Signature: t=…,v1=…, where v1 is the HMAC-SHA256 of <t>.<body> using the signing secret shown once when you add the webhook. Failed deliveries retry for about 7 hours; 50 failures in a row turn the webhook off. Send test sends a ping.

Built by IT, for IT

Need a hand?

Ask your company's Nidus admin about roles and modules. For anything else, or to bring Nidus to your team, get in touch.