Inclusi

API keys and webhooks

Create scoped API keys for your own systems and send signed webhooks when things change in Inclusi.

Updated on

Where: Settings, Integrations, then API keys or Webhooks. Both are on the Business and Enterprise plans. Ask support for the API documentation.

API keys

  1. Under Create a key, give it a Name, an Expires date and choose What it can do. A key can only do what you can do yourself.
  2. Choose Create key and copy it straight away: it is not shown again.
  3. Your system sends it as Authorization: Bearer <key>.

Keys are stored hashed and rate-limited. Revoke a key you no longer use, or that may have been seen: anything using it stops working. A key with reports access also works with the read-only OData feed for Power BI and Excel (see Build your own reports).

Webhooks

  1. Under Add a webhook, enter the Address (it must be https and on the public internet), a Description and the events, then Add webhook.
  2. Copy the signing secret (shown once). Each request has an Inclusi-Signature header your system checks with it.
  3. Send test sends a sample. Deliveries shows each attempt; failed deliveries are retried, and Retry now tries again. Send again re-sends one that was delivered, with the same event id so your system can ignore a repeat.

Delete removes a webhook.

Events: shift completed, created, changed or cancelled; participant added or changed; enquiry received; service agreement signed; incident recorded, or decided to be reportable; claim line rejected; invoice issued or paid. Each event carries record ids and a few fields, never names, notes or health details: your system fetches the rest with a key.

Public API (v1), Zapier and similar tools

The API is described at /api/v1/openapi.json. Version 1 adds:

  • Participants: find by email or NDIS number, create and update (scope participants.write). Only everyday details can be written through the API: never medical, behaviour support or Medicare details. A key cannot change participants through any other route.
  • Enquiries: record an enquiry (scope leads.write). The sending system must say the person agreed to be contacted, how, and the words they agreed to.
  • Invoices: list invoices with what is paid and owed (scope billing.read).
  • REST hooks: a tool such as Zapier subscribes a web address to an event with POST /api/v1/hooks and removes it with DELETE. A hook belongs to its key: revoking the key stops its hooks. A key can only subscribe to events about records its scopes can read. GET /api/v1/hooks/samples/<event> gives sample data for setting up a trigger.
Was this helpful?

Related articles

Need more help?

Contact support with the page you were on and what you expected to happen. Do not send participants' health details. Is Inclusi down? See the status page.