HomeWebBlocks UIWebBlocks CMSCommerce GuidePluginsArticles

Technical reference

WebBlocks Appointments documentation

Take bookings on your own site instead of sending visitors to a third-party scheduler.

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

Package identity

  • Handle: webblocks-appointments
  • Version: 0.15.1
  • Type: CMS plugin
  • License: MIT

Runtime requirements

  • Current version: 0.15.1
  • Host product: WebBlocks CMS
  • CMS compatibility: ^1.78.22
  • 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, internal API and public booking routes
  • Appointment Form block
  • Reminder command
  • Plugin health reporter

Permissions

  • webblocks-appointments.view
  • webblocks-appointments.manage
  • webblocks-appointments.settings

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

Data ownership

Owns appointment, service, staff, availability and reminder records. Appointment instants are stored in UTC; recurring availability uses the site's local wall-clock time.

Security model

CMS authentication and plugin permissions protect operator routes. Public booking remains inside the site; the plugin does not require an external scheduling account.

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 and changelog.

Operator behavior is documented; dedicated configuration, data-lifecycle and troubleshooting pages are still recommended.