InvergeDocs

REST API

The partner HTTP API every Nexus SDK speaks — call it from any language, or to reach an endpoint an SDK doesn't wrap yet.

Every SDK is a client of this API. You can call it directly from anything that speaks HTTP and JSON.

Base URLhttps://services.inverge.net
Authx-api-key: nxs_… on every request — see Authentication
FormatJSON request and response bodies (content-type: application/json)
ScopeEverything is scoped to the API key's environment
Errors{ "error": { "code", "message", "details" } } — see Errors
curl -X POST https://services.inverge.net/partner/events \
  -H 'x-api-key: nxs_live_xxx' \
  -H 'content-type: application/json' \
  -d '{ "distinctId": "user_123", "events": [{ "name": "order_placed", "properties": { "total": 42 } }] }'
{ "written": 1 }

Endpoints

The endpoint pages are generated from the backend's controllers and request validation, so field names, types and limits are exactly what the server checks.

Identity fields

Most ingest endpoints accept the same identity block alongside their payload — distinctId, sessionKey, deviceKey — plus client context such as release, appVersion, osType, osVersion and browser. The x-client-os and x-client-os-version headers fill osType / osVersion when the body doesn't. See Identity & sessions.

Validation

Request bodies are validated strictly: unknown fields, wrong types and values outside limits are rejected with 400 and a message naming the field. Batch endpoints cap their size (for example 1000 events per request, 5000 replay events per chunk).

On this page