Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.mailbreeze.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

The MailBreeze WordPress plugin provides one-click integration between your WordPress or WooCommerce site and MailBreeze. Once connected, customer data, orders, and form submissions flow automatically—no webhooks to configure, no fields to map.

​
Requirements

  • WordPress 6.0 or higher
  • PHP 8.0 or higher
  • WooCommerce 8.0+ (optional, for e-commerce features)

​
Installation

1

Download the plugin

Download the latest version from WordPress.org or get it directly:Download MailBreeze for WordPress
2

Install in WordPress

Go to Plugins > Add New > Upload Plugin and select the downloaded ZIP file.Or search for “MailBreeze” in the WordPress plugin directory.
3

Activate

Click Activate after installation completes.
4

Connect to MailBreeze

Navigate to Settings > MailBreeze, enter your API key, and click Connect.

​
Get Your API Key

  1. Log in to console.mailbreeze.com
  2. Go to Settings > Integrations
  3. Click Generate API Key for WordPress
  4. Copy the key and paste it in your WordPress settings
Keep your API key secret. If you suspect it has been compromised, regenerate it immediately from the MailBreeze dashboard.

​
Features

​
WooCommerce Integration

When WooCommerce is active and enabled in your MailBreeze dashboard:
EventWhat Happens
Customer createdContact synced to MailBreeze
Customer updatedContact updated in MailBreeze
Order placedOrder event triggers automations
Order status changedStatus change triggers automations
Guest checkoutEmail captured from billing details
The plugin is fully compatible with WooCommerce HPOS (High-Performance Order Storage).

​
Form Integrations

Capture leads from all major WordPress form plugins:

Contact Form 7

5M+ active installations

WPForms

6M+ active installations

Gravity Forms

Premium form builder

Elementor Forms

Part of Elementor Pro

Fluent Forms

Fast and lightweight

Ninja Forms

Drag and drop builder

Formidable Forms

Advanced form builder

Forminator

Free WPMU DEV plugin
Email, name, and phone fields are auto-detected—no manual field mapping required.

​
Dashboard Controls

Integrations are enabled and disabled from your MailBreeze dashboard, not WordPress. This allows you to:
  • Enable/disable WooCommerce sync
  • Enable/disable individual form plugins
  • Control what data flows to MailBreeze
Go to Settings > Integrations > WordPress in your MailBreeze dashboard to manage these settings.

​
Troubleshooting

​
Enable Debug Logging

  1. Go to Settings > MailBreeze in WordPress
  2. Toggle Enable Debug Logging
  3. Reproduce the issue
  4. View logs in the Debug Log section
Logs are written to wp-content/mailbreeze-debug.log.

​
Common Issues

  • Verify your API key is correct
  • Check that your server can reach api.mailbreeze.com
  • Look for errors in the debug log
  • Ensure the form plugin is enabled in your MailBreeze dashboard
  • Verify the form has an email field
  • Check that the plugin is connected (green status)
  • Confirm WooCommerce integration is enabled in MailBreeze dashboard
  • Check that “Sync Order Events” is enabled
  • Verify the order status changed (pending → processing, etc.)

​
Developer Hooks

Customize the plugin behavior with WordPress filters: 
// Modify payload before sending to MailBreeze
add_filter('mailbreeze_transform_payload', function($payload, $event_type) {
    // Add custom data
    $payload['custom_field'] = 'value';
    return $payload;
}, 10, 2);

// Conditionally prevent webhook sending
add_filter('mailbreeze_should_send_webhook', function($should_send, $event_type, $payload) {
    // Don't sync test orders
    if ($event_type === 'order.created' && str_contains($payload['email'], '@test.com')) {
        return false;
    }
    return $should_send;
}, 10, 3);

​
Uninstalling

When you delete the plugin (not just deactivate), all plugin data is removed:
  • API key and connection settings
  • Debug logs
  • Scheduled background tasks
Deactivating the plugin preserves your settings. Deleting it removes everything.

​
Support

Need help? Contact us at support@mailbreeze.com or check the WordPress.org support forum.