Build with Ovee

Connect your systems. Keep your organisation in sync.

Your organisation, connected

Use Ovee APIs to retrieve information your organisation can access. Subscribe to signed webhooks to react to partner, compliance, pool, people, onboarding, and job changes.

Read current records

Fetch the latest resource after receiving an event. The API reference covers supported integration operations and their generated schemas.

React to changes

Receive signed HTTPS notifications with stable event IDs. The webhook guide explains verification, retries, and replay.

Build a partner compliance integration

Follow the partner compliance How-to Guide to find a supplier by ABN, start onboarding, provide relationship evidence, and track reviewed compliance. Browse all How-to Guides.

Make your first request

Create an organisation API key. An organisation administrator opens Organisation Settings → APIs in Ovee. Follow the API key guide and copy the full key when it is shown.
Choose your application URL. Use the origin of the Ovee environment that issued your key. Your configured application is https://app.ovee.com.au. API paths start with /api.
Read the event catalogue. Set OVEE_BASE_URL to that application origin and enter your key privately as OVEE_API_KEY in your local environment. Run:
Terminal window
```
curl --fail-with-body \
  --header "Authorization: Bearer $OVEE_API_KEY" \
  "$OVEE_BASE_URL/api/webhooks/event-types"
```
This read-only request lists available event types and related API templates. It requires an organisation administrator API key.
Connect a receiver. Follow the webhook setup guide to create a subscription, verify signatures, and send your first test notification.

How access works

An API key is bound to an organisation and a user. Existing role, resource visibility, and organisation permissions still apply. Webhooks notify you of changes; fetching a linked resource requires its usual API permissions. A notification does not grant additional access.

The reference covers selected integration operations. Other endpoints used by the Ovee application are outside this published integration surface. Examples are copyable; this site does not execute API requests or collect your key.

Keep integrations resilient

Treat webhooks as at least once, with no ordering guarantee. Deduplicate by event ID, enqueue verified notifications durably, and retrieve current records in background processing. Resources can change or be deleted between a notification and your GET request.