Skip to content
  1. Extras
  2. mxHeadless
  3. Getting started
  4. Requirements

Requirements

Environment

ComponentVersion
MODX Revolution3.2.3+
PHP8.1+
xPDO~3.1 on stable branches, ^3.2 on current 3.x
DatabaseMySQL / MariaDB with InnoDB

Transport metadata declares modx >= 3.0.0. The package README and production sites target 3.2.3+.

Friendly URLs are recommended for the /api/v1 prefix. Without them, use the fallback api.php.

Compatibility matrix

MODXxPDOPHP
3.2.3-pl~3.18.1-8.3
3.x (dev)^3.28.2+

Optional

  • Cron or systemd for the webhook worker
  • HTTPS in production
  • Composer in core/components/mxheadless/ when installing manually from source