Welcome to Mautic’s developer documentation


Work is ongoing bringing over some of the content from the old documentation, which you can find at https://developer.mautic.org. Please see the developer documentation issue queue if you’d like to help with completing this work.

Welcome to the Mautic Developer Documentation. The documentation broadly covers building custom Plugins for Mautic which extends its features, building custom Themes, and how to integrate applications outside of Mautic using the REST API.

This documentation has multiple versions for different releases of Mautic starting from Mautic 4.x - the switcher is in the bottom left which allows you to change between versions.

Submitting code to Mautic

Development is open and available to any member of the Mautic community. All fixes and improvements happen through pull requests to the code on Mautic’s GitHub repository. This code is open source and publicly available.

Read all about contributing to Mautic as a Developer in the Mautic Developer Contribution Guide.

Read more about Mautic’s code governance and the Mautic Project Governance model.

Your code must follow the Symfony coding standards. You can find details about where Mautic deviates from these standards documented in the Deviations from the standard Symfony Framework section.

Where to get help

The first place to ask for support is on the Developer Forum - this is where the Product Team monitors, and where most developers look out for posts they can assist with. There is also a Commercial forum if you have paid opportunities or are looking for work.

General development chatter also happens in #dev on Slack, and anything to do with contributing - including the weekly Open Source Friday contribution sprints - happen in #t-product.

New major releases also have a dedicated space for discussion - for example #mautic-5 and #mautic-6.

Several areas on the Community Portal could be of interest, including proposals for new major features and the Product Team Assembly.

Supporting Mautic

There are several ways to support Mautic other than contributing with code.

  1. Help with testing bugs and features using Gitpod in the browser - head to the Tester Documentation

  2. Help with improving the documentation on this site, and the end-user documentation.

  3. Contributing to Mautic with other skills

  4. Become a Member of Mautic

  5. Support Mautic on Open Collective

Indices and tables