Skip to content

Plugins Overview

The Vivified platform is built on a powerful plugin architecture that enables modular, extensible functionality while maintaining security and HIPAA compliance. Plugins are the primary way to extend and customize the platform.

  • :material-puzzle:{ .lg .middle } Modular Architecture

    Isolated microservices communicate through well-defined APIs

  • :material-security:{ .lg .middle } Secure by Default

    Sandboxed execution with policy-based access control

  • :material-code-tags:{ .lg .middle } Polyglot Support

    Build plugins in Python, Node.js, Go, or any language

What are Plugins?

Plugins are containerized microservices that add features to Vivified without modifying core code. Each plugin:

  • Runs in isolation - Containerized with resource limits
  • Communicates through APIs - REST or gRPC interfaces
  • Follows security policies - Enforced by the core platform
  • Integrates with Admin UI - Provides web-based management

Plugin Categories

Category Purpose Examples
Storage Data persistence and retrieval S3 adapter, PostgreSQL connector
Communication Messaging and notifications Email sender, SMS gateway, Slack
Identity User management and authentication LDAP, OAuth2, SAML
Processing Data transformation and analysis OCR engine, ML models, ETL
Integration External system connectors EHR systems, billing platforms

Three-Lane Communication Model

All plugin interactions follow one of three supervised communication patterns:

mermaid graph LR Plugin1[Plugin A] -->|Canonical Events| EventBus[Event Bus] EventBus --> Plugin2[Plugin B] Plugin1 -->|Operator API| Gateway[Core Gateway] Gateway --> Plugin2 Plugin1 -->|Proxy Lane| Proxy[Core Proxy] Proxy -->|Filtered| External[External API]

1. Canonical Lane

  • Purpose: Asynchronous event-driven communication
  • Format: Normalized canonical data models
  • Example: User created, document processed, payment received

2. Operator Lane

  • Purpose: Synchronous API calls between plugins
  • Format: REST/gRPC with authentication
  • Example: Fetch user details, validate configuration

3. Proxy Lane

  • Purpose: Controlled external API access
  • Format: HTTP/HTTPS with domain allowlisting
  • Example: Call third-party services, webhooks

Plugin Lifecycle

mermaid stateDiagram-v2 [*] --> Unregistered Unregistered --> Registered: Register with manifest Registered --> Active: Enable plugin Active --> Disabled: Disable plugin Disabled --> Active: Re-enable Active --> Unhealthy: Health check fails Unhealthy --> Active: Health restored Disabled --> Unregistered: Unregister

Getting Started

Quick Start

  1. Browse Available Plugins
  2. Visit Admin Console → Plugins → Marketplace

  3. Filter by category, traits, or capabilities

  4. Install a Plugin

  5. Click "Install" on desired plugin
  6. Configure required settings

  7. Enable and verify health status

  8. Build Your Own

  9. See Development Guide for detailed instructions
  10. Use SDK for your preferred language: Python, Node.js, Go
  11. Follow the Plugin Examples

Plugin Manifest

Every plugin requires a manifest declaring its capabilities and requirements:

{
  "id": "my-plugin",
  "name": "My Plugin", 
  "version": "1.0.0",
  "contracts": ["StoragePlugin"],
  "traits": ["handles_pii", "audit_required"],
  "security": {
    "authentication_required": true,
    "data_classification": ["pii"]
  },
  "allowed_domains": ["api.example.com"]
}

Security & Compliance

Security Requirements

Security Mandatory

All plugins MUST implement authentication and declare data classification

  • Authentication: Required for all plugin endpoints
  • Authorization: Role-based access control via traits
  • Audit Logging: Automatic for sensitive operations
  • Data Classification: Must declare PII/PHI handling

HIPAA Compliance

For healthcare deployments, plugins handling PHI must:

  • Declare handles_phi trait
  • Implement required HIPAA controls
  • Support 7-year audit retention
  • Encrypt data at rest and in transit

Plugin Management

Admin Console Features

Feature Description Access Required
Browse Marketplace View available plugins admin
Install/Uninstall Manage plugin lifecycle plugin_manager
Configure Edit plugin settings config_manager
Monitor Health View status and metrics admin
View Audit Logs Track plugin actions audit_viewer

CLI Management

# List installed plugins
vivified plugins list

# Install from marketplace
vivified plugins install <plugin-id>

# Configure plugin
vivified plugins config <plugin-id> --set key=value

# Check plugin health
vivified plugins health <plugin-id>

Available Plugins

Core Plugins

Community Plugins

Browse the Plugin Marketplace for community-contributed plugins.

Best Practices

Plugin Development Tips

  1. Start with the SDK for your language
  2. Follow the principle of least privilege
  3. Implement comprehensive health checks
  4. Provide Admin UI components when applicable
  5. Document all configuration options

Next Steps