HomeWebBlocks UIWebBlocks CMSCommerce GuidePluginsArticles

Technical reference

WebBlocks Support documentation

Connect a CMS installation to any compatible support provider and manage tickets from the admin panel.

Values below come from the current package manifest and Composer metadata.

Package identity

  • Handle: webblocks-support
  • Version: 0.3.3
  • Type: CMS plugin
  • License: MIT

Runtime requirements

  • Current version: 0.3.3
  • Host product: WebBlocks CMS
  • CMS compatibility: ^1.75.0
  • PHP: >=8.4
  • License: MIT
  • Catalog status: Public catalog plugin

Installation is disabled-by-default and setup remains an explicit operator action.

  1. Open System → Plugins in a compatible WebBlocks CMS installation.
  2. Install the catalog release or upload its validated ZIP artifact.
  3. Review the manifest, compatibility and permissions before enabling it.
  4. Enable the plugin, then run explicit plugin setup or migrations when health reports that setup is required.
  5. Confirm plugin health and complete product-specific settings before exposing its public workflow.

Updates: review release notes and compatibility first. Package replacement must not silently enable the plugin or run migrations.

Inspectable behavior contributed to the host product.

Registered surfaces

  • Admin routes
  • Support provider protocol
  • Connection health reporter
  • Encrypted provider connection storage

Permissions

  • webblocks-support.access
  • webblocks-support.manage

The public contract describes ownership without exposing secrets or private implementation details.

Data ownership

Owns the support connection and ticket interaction state required by its provider contract. Commercial entitlement rules remain outside the plugin and CMS core.

Security model

Diagnostics are collected only after an administrator approves named categories. Credentials, cookies, tokens, full logs and arbitrary paths are excluded.

Disable and uninstall

Disabling makes plugin-owned routes, menus, blocks and behavior inert. Run migrations explicitly after compatible updates. Before uninstalling, export or back up plugin-owned data; package removal and data removal are separate lifecycle decisions.

Health and troubleshooting

Start with the plugin detail screen and health result. Confirm compatibility, required migrations, host services, scheduled commands and external-provider configuration before inspecting application logs.

What exists in the local package today, and what should be expanded next.

Current source set: README, changelog and support protocol v1.

Protocol and privacy boundaries are strong; add operator troubleshooting and provider implementation examples.