konecty-meta-document
Konecty Meta Document
Manage document-type metadata definitions (fields, labels, events, indexes).
Prerequisites
Requires admin credentials from konecty-session. User must have admin: true.
API Endpoints
| Endpoint | Method | Description |
|---|---|---|
/api/admin/meta/:document/document/:document |
GET | Get full document meta |
/api/admin/meta/:document/document/:document |
PUT | Upsert document meta |
Workflow
1. Show a document definition
python3 scripts/meta_document.py show Contact
2. List fields
python3 scripts/meta_document.py fields Contact
python3 scripts/meta_document.py fields Contact --format json
3. Add a field
python3 scripts/meta_document.py add-field Contact myNewField \
--type text --label-en "My Field" --label-pt "Meu Campo" --required
4. Remove a field
python3 scripts/meta_document.py remove-field Contact myNewField
5. Update a field property
python3 scripts/meta_document.py update-field Contact status --set isRequired=true
python3 scripts/meta_document.py update-field Contact status --set 'label.en=Status Name'
6. Upsert full document
python3 scripts/meta_document.py upsert Contact --file document.json
7. List document events
python3 scripts/meta_document.py events Contact
Key concepts
fieldsis an object-map{ "fieldName": { ... } }, not an array- Field types: text, number, boolean, date, dateTime, picklist, lookup, email, phone, address, personName, money, file, composite, filter, richText, autoNumber, etc.
- See references/field-architecture.md for full field type documentation
- See references/document-events.md for queue/webhook event configuration
Script reference
See scripts/meta_document.py. Stdlib only.
More from konecty/skills
konecty-meta-namespace
Manage Konecty Namespace global configuration: email servers, RabbitMQ queue config, storage, webhooks, plan settings, portal config. Use when the user wants to configure SMTP servers, add RabbitMQ queues, set up storage, configure global webhooks (onCreate/onUpdate/onDelete), manage Konsistent settings, or view global tenant configuration. Requires admin credentials.
9konecty-session
Opens a Konecty session via OTP login (request OTP, then verify OTP) and persists the access token in .env or ~/.konecty/credentials for use by other skills. Use when the user wants to log in to Konecty with OTP, store credentials, set up KONECTY_TOKEN, or establish a session so other Konecty skills can call the API. Only works when the namespace has OTP enabled (email or WhatsApp).
8konecty-create
Creates records in any Konecty module via POST /rest/data/:document. Guides through the full pre-creation workflow: discovering fields and types with konecty-modules, resolving lookup _ids with the built-in lookup command, checking picklist options, validating required fields, and submitting the payload. Use when the user wants to create a new record, insert data, send a message, add an activity, register a contact, create an opportunity, or create any document in Konecty. Requires an active konecty-session (KONECTY_URL and KONECTY_TOKEN in ~/.konecty/.env or ~/.konecty/credentials).
8konecty-meta-list
Manage Konecty list view metadata: show list definitions, manage columns, filters, sorters, calendars, and boards. Use when the user wants to create or modify list views, change column visibility or order, update default filters, or configure calendar/board views. Requires admin credentials.
8konecty-meta-view
Manage Konecty form view metadata: show view definitions, inspect visual tree (visualGroups, visualSymlinks, reverseLookups), upsert views. Use when the user wants to create or modify form layouts, rearrange fields in forms, add visual groups, or configure reverse lookups in views. Requires admin credentials.
8konecty-meta-hook
Generate and manage Konecty hook code: scriptBeforeValidation, validationData, validationScript, scriptAfterSave. Use when the user wants to create, read, update, or delete hooks, generate hook code from requirements, scaffold hook templates, or validate hook correctness. Requires admin credentials.
8