Ninox
Read and write Ninox 4 records, inspect modules, tables, fields, views and reports, poll record changes, and run scripts in a Ninox workspace.
About
Ninox ships in the w6w first-party pack. It declares 22 actions, 2 health checks, and the host runs its code in a sandbox that never sees the credential.
- App id
io.w6w.ninox- Version
- 0.1.0
- Author
- w6w
- Licence
- MIT
- Categories
- Databases · Productivity
Overview
Ninox 4 is a low-code platform for building business apps: a workspace holds modules, each module holds tables, and each table holds fields and records. This app connects a workflow to one Ninox workspace through its public API.
It reads and writes records (list with filters, sorting and field selection; create, update, delete and upsert in batches of records), polls the change log of a table or of the workspace schema for incremental sync, and runs a Ninox script against a record. It also exposes the structure around the data: modules, tables, fields, views, reports and global function scripts, and renders a report to a PDF for a record.
A Ninox API key belongs to exactly one workspace, so a Connection is a workspace id plus its key. Creating or altering modules, tables and fields, file uploads and CSV import are not covered by this version.
Build with Ninox
Three routes to the same 22 actions. The Workflow tab is generated from Ninox's own manifest and carries its real ids, so it is copy-pasteable; the Code and CLI examples are the same call for any action on any app, so every app-specific value in them is a blank you fill in.
List Global Functions
function-list List a module's global function scripts (name and code), in the order they compile.
List Modules
module-list List the modules in the workspace (each carries its tables, components and roles).
List Record Changes
record-changes-list List record ids created, updated or deleted since a timestamp (incremental sync). The table must have history tracking enabled. Pass the result's asOf as `since` on the next poll.
Create Records
record-create Create one or more records (up to a 6 MB payload). Each entry maps field names to values.
Delete Records
record-delete Delete records by id in one transaction. If any id is invalid or missing, nothing is deleted.
Get Record
record-get Read one record by its id. The record id is not filterable, so this is the only way to fetch a known record.
List Records
record-list List records of a table with optional field selection, a JSON equality filter and sorting. Page with limit/offset while hasMore is true.
Update Records
record-update Update existing records. Each entry must carry the record's `id` plus the fields to change; the whole batch succeeds or none of it does. Set a field to null to clear it.
Upsert Records
record-upsert Create or update records matched by one unique field. Every record must carry a value for the match field.
List Reports
report-list List the printable reports defined on a table; each has the id Print Report needs.
Print Report
report-print Render a report for a record (or a merged run over several) as a PDF and return a presigned download URL.
List Schema Changes
schema-changes-list List created/updated/deleted/restored modules, tables and fields since a timestamp. Pass the result's asOf as `since` on the next poll; when paging, pass the first page's asOf back as `asOf`.
Execute Script
script-exec Run a Ninox script expression, optionally against one record, and return its result. Writes and triggers are enabled, so the script can change data.
Get Table
table-get Read one table's definition: fields, permission guards and whether it keeps history (required by List Record Changes).
Get Workspace
workspace-get Read the connected workspace: its name and the full definition of every module. The result can be large; use List Modules or List Tables when only names are needed.
A workflow step names the app and the action, and the editor fills in the
connection when you pick one. This is the Step shape from the
workflow spec, carrying Ninox's real ids.
{
"manifestVersion": "2",
"name": "ninox-example",
"steps": [
{
"id": "field-get",
"uses": {
"app": "io.w6w.ninox",
"action": "field-get",
"connection": "conn_YOUR_CONNECTION_ID"
},
"with": {
"moduleName": "<moduleName>",
"tableName": "<tableName>",
"fieldName": "<fieldName>"
}
}
]
}Here are some of the things you can do
-
Get Field
readfield-get -
List Fields
readfield-list -
List Global Functions
readfunction-list -
Get Module
readmodule-get -
List Modules
readmodule-list
+17 more actions available
Every app-specific value here is a blank you have to fill in. An
app action is reached through the connection that authenticates it, so the
address is a connection id, not the app id — and connections belong to your account,
so a public page cannot know yours. Create one for Ninox, then fill in
the three blanks: conn_YOUR_CONNECTION_ID, the action key, and the
parameters that action declares. The call itself is real — the shape is transcribed
from the studio's own snippet builder, which prints the same kind of blanks — but
nothing in it is specific to Ninox. The Workflow tab is where this app's
real ids are.
npm install @w6w/sdkyarn add @w6w/sdkpnpm add @w6w/sdkdeno add npm:@w6w/sdkimport { W6wClient, isActionRun } from "@w6w/sdk";
// Reads W6W_BASE_URL and W6W_TOKEN from the environment when omitted.
const client = new W6wClient();
const envelope = await client.run({
urn: "conn_YOUR_CONNECTION_ID",
action: "field-get",
payload: {
moduleName: "<value>",
tableName: "<value>",
fieldName: "<value>",
},
});
if (isActionRun(envelope)) console.log(envelope.value);npm install -g @w6w/cliw6w run conn_YOUR_CONNECTION_ID --action field-get --payload '{"moduleName":"<value>","tableName":"<value>","fieldName":"<value>"}'Give an AI agent Ninox — without giving it Ninox's credentials. One MCP endpoint exposes every app, function and workflow the caller is entitled to, as tools it can discover and run. Access is granted per team while we onboard.
One tool call{
"name": "w6w_invoke",
"arguments": {
"ref": "app:io.w6w.ninox#field-get",
"input": {
"moduleName": "<moduleName>",
"tableName": "<tableName>",
"fieldName": "<fieldName>"
}
}
}
Every tool names its target with a single ref. The
app: form above doesn't name a connection at all — the
host resolves which of the caller's Ninox connections to sign
with, and refuses rather than guesses when the answer is ambiguous.
What the agent gets
Credentials it can't read
The token is attached host-side, at the moment of the call. It is never a tool argument, never in the model's context, and never in a transcript — so a prompt injection has nothing to exfiltrate.
A tool surface scoped to the caller
Tools are derived per end user from what that person has actually connected and is entitled to — not one shared bot identity carrying the union of everyone's access.
A durable workflow in one call
Multi-step work runs on the workflow engine and returns a run handle the agent can poll — retries, branching and state survive the conversation that started them.
Health-aware discovery
Ninox's declared health checks are on the surface too, so an agent can tell "the vendor is down" from "your credential expired" before it burns a retry on either.
The MCP surface is part of the hosted platform. Ninox itself is MIT, and the runtime that executes it is source-available (FSL).
Health checks
Ninox declares its own checks, so its health is a property of the app rather than something the host guesses at.
Ninox platform status
API reachable
Unsigned GET https://go.ninox.com/api/v1/workspace/aaaaaaaaaaaa. A non-HTML 401 is the gateway refusing an unsigned request, which proves the API is answering; an HTML body is the web-app shell, not the API.