Module Developer & Publisher Guide
15 min read · Software engineers and extension developers
Build, test, and publish specialized capabilities for Solace Buzz communities
Complete specification for developing Solace Buzz modules: manifest schema, capability verbs, permission boundaries, deterministic packaging, and lifecycle testing.
1. What is a Module?
A Solace Buzz module is a self-contained extension that adds specialized capabilities, data schemas, and automated tools to a community. First-party examples include CRM (contacts & deals), Social (outreach & post drafts), Finance (budgets & reconciliation), and Studio (media generation).
Modules must respect strict tenant isolation and cannot bypass user permissions.
2. Anatomy of a Module
A module package consists of:
•
module.json: The manifest defining identity, publisher, version, dependencies, and capability verbs.
• runtime.py: Entry point implementing handlers for each declared capability verb.
• schema.json: JSON Schema validating input arguments and returned output structures.
• tests/: Conformance test suite verifying lifecycle actions.3. Declaring Capabilities & Permission Grants
Every action a module can perform must be explicitly declared as a capability verb in
module.json. For example:
{
"capabilities": [
{"verb": "crm.contacts.read", "description": "Read customer contact list", "requires_review": false},
{"verb": "crm.deals.create", "description": "Create a new deal record", "requires_review": true}
]
}
Actions marked with requires_review: true cannot execute automatically; they must pause for human confirmation.4. Packaging, Integrity Hashing, and Lifecycle
Before a module can be installed:
1. A deterministic SHA-256 hash of the package contents must be computed.
2. The installation engine verifies that the package digest matches the publisher's registered hash.
3. Community owners must review and accept the exact list of requested permissions.
All modules support the standard lifecycle:
install → execute → disable → uninstall → export.Have a question about this guide? Email our team at support@solacebuzz.com and we will be glad to assist.