Set up a workspace or a development install
API and webhook work needs a workspace and a key; plugin work needs your own install of the code, where you are super admin.
For API and webhook integrations
Use a zmle workspace where you are an admin (a trial workspace is fine).
Open Admin → Settings → Integrations & API (
/admin/integrations, permissionsettings.integrations).Create an API key: a name, the scopes you need, an optional expiry. Copy the key — it is shown once; only its SHA-256 hash is stored.
Put it in an environment variable on your machine, never in source code.
Call
GET /api/v1/meto see which key you are and which scopes it has.
export ZMLE_BASE="https://your-workspace.zmle.com/api/v1"
export ZMLE_KEY="fx_live_..." # paste your key; never commit it
curl -s "$ZMLE_BASE/me" -H "Authorization: Bearer $ZMLE_KEY"For plugins, widgets and core changes
Plugins are installed for a whole server, so you develop them on your own single-company install of the code, where you are super admin. The install guide covers Docker, a VPS, Windows Server and shared hosting.
# Node 20+, PostgreSQL 15+ (or MySQL 8 / MariaDB 10.6+)
unzip <release>.zip -d app && cd app
node start.mjs # first start installs dependencies, then open http://localhost:3000/install
# or with Docker (PostgreSQL 17 + the app)
docker compose up -d- Plugin folders live under
modules/<id>/; the reference plugin ismodules/example-checklist/and the manifest template ismodules/_templates/module.json. - Install, update and Module Studio writes need a super admin;
ALLOW_SELF_UPDATE=0locks the build pipeline (use it in production, not on your dev install). - Run
npm run plugin:check <id>to validate a manifest and run the plugin's own test file.
Written from: docs/API.md, docs/INSTALL.md, docs/PLUGINS.md, modules/_templates/module.json, src/lib/integrations/webhooks.ts