Skip to Content
APIOverview

Novex API

The Novex API lets your own systems read data out of Novex — events, registrations (including check-in state), invoices and people — and write a few things back: creating a registration, checking an attendee in, and managing outbound webhooks. It is a normal REST API over HTTPS returning JSON.

⚠️ Preview. This is version 2026-08-04-preview. It is usable and credentialed, and we will not remove or rename anything silently — but the shape may still change before we mark it stable. See Versioning for exactly what can and cannot change.

Before you start

  • Plan requirement. API access is available on Spectrum and above. On Beam or Flare, every request returns 402.
  • Create a key. Settings → API, as a tenant admin. The key is shown once.
  • Base URL. https://nov3x.com/api/public/v1

Your first request

curl -sS https://nov3x.com/api/public/v1/events \ -H "Authorization: Bearer nvx_live_your_key_here"
{ "data": [ { "id": "clx1234567890", "name": "Riyadh Tech Summit", "type": "EXHIBITION", "status": "CONFIRMED", "startAt": "2026-09-01T08:00:00.000Z", "endAt": "2026-09-02T17:00:00.000Z", "createdAt": "2026-05-01T09:12:44.000Z", "updatedAt": "2026-08-01T11:03:02.000Z" } ], "meta": { "total": 1, "cursor": null, "hasMore": false } }

What is in this release

Everything below is live in the preview today — the list is taken from the OpenAPI document the API generates for itself, so it says what the API actually serves rather than what was planned.

Reading

  • Events — list and fetch one.
  • Registrations — list and fetch one, including check-in state.
  • Invoices — list and fetch one.
  • People — list and fetch one, plus a removals feed so a system you have synced can learn that someone was erased.
  • Webhook endpoints — list your endpoints and read the delivery log for one.
  • Accreditation — one registration’s accreditation decision, and whether its credential still stands.

Writing

  • Create a registration — POST /registrations.
  • Check in an attendee — POST /registrations/{id}/check-in.
  • Manage webhook endpoints — create, update and delete them, replay a delivery, and rotate a signing secret in two steps.

Every write takes an idempotency key; see Idempotency for the rule and Writes for what a write changes.

Machine-readable spec

An OpenAPI 3.1 document is served at /api/public/v1/openapi.json. It needs no key — you can read it before you have one. It is generated from the same definitions the API responds with, so it does not drift from the live behaviour.

In this section

  • Authentication — creating, using, rotating and revoking keys.
  • Idempotency — the key every write must carry.
  • Writes — what changes when a request changes something.
  • Rate limits — the ceilings and the headers.
  • Versioning — what counts as a breaking change.
  • Changelog — dated changes to the API.
  • Errors — every error code and what causes it.
  • Webhooks — subscribing an endpoint, verifying the signature, retries and replay.
Last updated on