Mautic Developer Documentation

Development Environment

  • Development environment
  • How to install Mautic with DDEV
  • How to install Mautic manually
  • Environments

Design and UX

  • Accordion component
  • Depicting availability of interface elements
  • Displaying elements based on User permissions
  • Providing effective user feedback
  • Guidelines for labelling the Mautic interface
  • Notifications
  • ProTip template to enhancing user experience
  • Quick filters for searches
  • Retrieving Mautic settings in Twig
  • Using the Tile Component
  • Utilities

Themes

  • Getting started with Themes
  • GrapesJS Builder
  • Legacy Builder
  • Customizing Forms
  • Overriding core view templates

Form Hooks

  • Getting started with Form hooks
  • General hooks
  • Validation hooks
  • Response hooks

Webhooks

  • Getting started with Webhooks
  • Webhook example scripts
  • Webhook events and payloads

Mautic Marketplace

  • Marketplace
  • Listing a Plugin in the Marketplace
  • Allow list: what is it and why is it needed?
  • Best practices

Plugins

  • Getting started with Plugins
  • Autowiring
  • Deviations from the standard Symfony Framework
  • Plugin dependencies
  • File and directory structure
  • Config file
  • Event listeners
  • Installing, upgrading, and uninstalling
  • Cache
  • Translating Plugins
  • Continuous Integration
  • Update Plugins for Mautic 5
  • MVC - Model-View-Controller
  • Roles and permissions

Plugin Extensions

  • Manipulating Contacts
  • API
  • Campaigns
  • Categories
  • Channels
  • Contacts
  • Emails
  • Forms
  • Forms - advanced
  • Integrations
  • Landing pages
  • Maintenance cleanup
  • Points
  • Reports
  • UI - User Interface
  • Webhooks

Plugin Integrations

  • Getting started with Integrations

Plugin Services

  • Cookie helper
  • Database or entity manager
  • Event dispatcher
  • Factory
  • IP lookup services
  • Mail helper
  • Model factory
  • Config parameters
  • Paths helper
  • Plugin config helper
  • Request
  • Router
  • Security
  • Session
  • Translator
  • User

Miscellaneous

  • Commands
  • Events
  • Flash messages
  • Forms
  • Helpers
  • Implementing translation support to entities
  • Implementing variant - A/B test - support to entities

REST API

  • Getting started with REST API
  • Authorization
  • Assets
  • Campaigns
  • Categories
  • Companies
  • Contacts
  • Dashboard widget data
  • Dynamic Content
  • Emails
  • Fields
  • Files
  • Focus
  • Forms
  • Marketing Messages
  • Notes
  • Notifications
  • Pages
  • Point Actions
  • Point Groups
  • Point Triggers
  • Reports
  • Roles
  • Segments
  • Stages
  • Stats
  • Tags
  • Text messages
  • Themes
  • Tweets
  • Users
  • Webhooks

MauticJS API

  • Tracking script MauticJS (mtc.js)

Testing

  • End to end test suite
Mautic Developer Documentation
  • Cookie helper
  • Edit on GitHub

Cookie helper

Note

The content for this page requires a major update. The legacy page contains outdated and potentially inaccurate information. You can still access it in the Mautic Developer Documentation archived repository.

If you’re interested in helping develop the new content for this page and others, consider joining the documentation efforts.

Please read the Contributing Guidelines and Contributing to Mautic’s documentation to get started.

Previous Next

© Copyright 2021, Mautic contributors.

Built with Sphinx using a theme provided by Read the Docs.