HomeWebBlocks UIWebBlocks CMSCommerce GuidePluginsArticles

Technical reference

WebBlocks Campaigns documentation

Send templated email to your own customer list with per-recipient fields and explicit consent controls.

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

Package identity

  • Handle: webblocks-campaigns
  • Version: 0.7.0
  • Type: CMS plugin
  • License: MIT

Runtime requirements

  • Current version: 0.7.0
  • Host product: WebBlocks CMS
  • CMS compatibility: ^1.45.5
  • PHP: >=8.3
  • 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 and public routes
  • Newsletter Sign-up block
  • Scheduled dispatch command
  • Mail transport supplied by the host

Permissions

  • webblocks-campaigns.view
  • webblocks-campaigns.manage
  • webblocks-campaigns.send
  • webblocks-campaigns.settings

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

Data ownership

Owns contacts, lists, consent records, campaigns, deliveries, suppression and bounce state. Sending is batched and never runs inside the initiating web request.

Security model

Release-to-send is a separate permission. Unsubscribe is mandatory for the commercial channel, and suppression remains independent from list membership.

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 design notes.

Strong behavioral design documentation; a standalone configuration and deliverability troubleshooting guide should be added.