InvergeDocs

Realtime

Emit to rooms and manage the room registry and payload schemas.

Partner (API-key) room management — wire-compatible with the current backend's /partner/rooms surface (register/list/delete, relations, payload schema). Scoped to the key's environment.

Partner HTTP surface (SDK server-side emit). Authenticated by x-api-key, NOT the console JWT — hence @Public() (skips the global JWT guard) plus ApiKeyGuard. Mounted at /partner/... (excluded from the /api prefix) to stay wire-compatible with the existing SDKs.

GET /partner/rooms

GET 200 x-api-key
Request
curl -X GET 'https://services.inverge.net/partner/rooms' \
  -H 'x-api-key: nxs_live_xxx'

POST /partner/rooms

POST 201 x-api-key

Body — { name?: string; type?: string }

Request
curl -X POST 'https://services.inverge.net/partner/rooms' \
  -H 'x-api-key: nxs_live_xxx'

DELETE /partner/rooms/{id}

DELETE 200 x-api-key

Path parameters

Prop

Type

Request
curl -X DELETE 'https://services.inverge.net/partner/rooms/{id}' \
  -H 'x-api-key: nxs_live_xxx'

POST /partner/rooms/{id}/link/{relatedId}

POST 201 x-api-key

Path parameters

Prop

Type

Request
curl -X POST 'https://services.inverge.net/partner/rooms/{id}/link/{relatedId}' \
  -H 'x-api-key: nxs_live_xxx'

DELETE /partner/rooms/{id}/schema

DELETE 200 x-api-key

Path parameters

Prop

Type

Request
curl -X DELETE 'https://services.inverge.net/partner/rooms/{id}/schema' \
  -H 'x-api-key: nxs_live_xxx'

GET /partner/rooms/{id}/schema

GET 200 x-api-key

Path parameters

Prop

Type

Request
curl -X GET 'https://services.inverge.net/partner/rooms/{id}/schema' \
  -H 'x-api-key: nxs_live_xxx'

POST /partner/rooms/{id}/schema

POST 201 x-api-key

Path parameters

Prop

Type

Body — { schema?: unknown }

Request
curl -X POST 'https://services.inverge.net/partner/rooms/{id}/schema' \
  -H 'x-api-key: nxs_live_xxx'

POST /partner/rooms/{id}/schema/enable

POST 201 x-api-key

Path parameters

Prop

Type

Body — { enabled?: boolean }

Request
curl -X POST 'https://services.inverge.net/partner/rooms/{id}/schema/enable' \
  -H 'x-api-key: nxs_live_xxx'

POST /partner/rooms/{id}/unlink/{relatedId}

POST 201 x-api-key

Path parameters

Prop

Type

Request
curl -X POST 'https://services.inverge.net/partner/rooms/{id}/unlink/{relatedId}' \
  -H 'x-api-key: nxs_live_xxx'

POST /partner/rooms/{name}/emit

POST 201 x-api-key

Path parameters

Prop

Type

Headers

Prop

Type

Body — EmitBody

Prop

Type

Request
curl -X POST 'https://services.inverge.net/partner/rooms/{name}/emit' \
  -H 'x-api-key: nxs_live_xxx' \
  -H 'content-type: application/json' \
  -d '{
      "event": "status",
      "events": {},
      "payload": {}
    }'

GET /partner/rooms/{name}/related

GET 200 x-api-key

Path parameters

Prop

Type

Request
curl -X GET 'https://services.inverge.net/partner/rooms/{name}/related' \
  -H 'x-api-key: nxs_live_xxx'

POST /partner/rooms/emit

POST 201 x-api-key

Headers

Prop

Type

Body — BatchBody

Prop

Type

Request
curl -X POST 'https://services.inverge.net/partner/rooms/emit' \
  -H 'x-api-key: nxs_live_xxx' \
  -H 'content-type: application/json' \
  -d '{
      "rooms": [
        {}
      ]
    }'

On this page