Deal Flow Documentation

Complete guide to installing, configuring, and using Deal Flow for Mautic®.

Installation

Deal Flow installs as a standard Mautic plugin via download and extract.

Requirements

• Mautic 7.x (mostly compatible with 5.x+, PHP 8.1+)
• MySQL 8.0+ or MariaDB 10.4+

Install

# From your Mautic root directory
wget https://dealflowplugin.com/download/DealFlowBundle.zip
unzip DealFlowBundle.zip -d plugins/

# Clear and rebuild cache (run as web server user)
sudo -u www-data php bin/console cache:clear --no-warmup
sudo -u www-data php bin/console cache:warmup

# Load the plugin (runs database migrations)
sudo -u www-data php bin/console mautic:plugins:reload

Verify Installation

Navigate to /s/dealflow in your Mautic instance. You should see the Deal Flow pipeline view. The plugin also registers a Deal Flow entry in the Mautic main menu.

Quick Start

Get your first deal tracked in five steps:

1. Install the plugin using the wget/unzip instructions above.
2. Create a pipeline. Go to Deal Flow → Pipelines → New. Name it (e.g., "Sales Pipeline") and add stages: Qualification, Discovery, Proposal, Negotiation, Closed Won, Closed Lost. Set probability percentages for each stage.
3. Create a deal. Go to Deal Flow → Deals → New. Enter a title, amount, select your pipeline, choose an initial stage, and assign an owner.
4. Add buying committee members. On the deal detail page, click "Add Contact" to associate Mautic contacts with roles like Decision Maker, Champion, or Influencer.
5. Track progress. Drag deals between stages on the kanban board. Add notes, tasks, and attachments as the deal progresses.

Configuration

Access Deal Flow settings at Deal Flow → Config.

Display Preferences

Risk Thresholds

Health indicators on the kanban board use days-in-stage to flag stale deals:

Task Settings

Integration

Pipeline Management

Creating a Pipeline

Navigate to Deal Flow → Pipelines → New. Each pipeline needs:

• Name — descriptive label (e.g., "Enterprise Sales", "SMB Pipeline")
• Default flag — mark one pipeline as default for new deals
• Stages — ordered list of deal stages

Stages

Each stage has:

Bidirectional Stage Sync

Deal stages can be mapped to Mautic contact stages. When a deal moves to a mapped stage, all associated contacts are updated in Mautic. When a contact's Mautic stage changes (e.g., via a campaign), associated deals are updated automatically.

Configure mappings in the pipeline stage editor by selecting a corresponding Mautic contact stage.

Deals

Creating a Deal

New deals require a title and a pipeline. All other fields are optional:

Kanban Board

The pipeline kanban view shows deals as cards organized by stage. Drag and drop to move deals between stages. Cards display:

• Deal title and amount
• Owner avatar
• Health indicator (green/yellow/red based on days in stage)
• Buying committee count

Batch Actions

Select multiple deals in list view to:

• Move to a different stage
• Change owner
• Update status (mark won/lost)
• Delete

Search

Use the search input on the deal list to filter by title, company, owner, or stage. Supports Mautic's standard search syntax.

CSV Import

Import deals in bulk via Deal Flow → Import. Upload a CSV with headers matching deal fields. The importer supports field mapping for non-standard column names.

Deal Notes & Activity

Add notes to deals with activity types:

• note — general notes
• call — phone call records
• email — email summaries
• meeting — meeting notes
• task_completed — completed task records

Tasks

Create tasks associated with deals. Each task has a title, description, priority, due date, optional reminder, and assigned owner.

Attachments

Upload files (proposals, contracts, etc.) to the deal record for centralized document management.

Buying Committee

Buying Committee Intelligence is Deal Flow's structural differentiator. It lets you map multiple Mautic contacts to a deal, each with a role label that describes their influence on the buying decision.

Adding Contacts

On the deal detail page, use the Add Contact button to search for and associate Mautic contacts. Assign a role label to each:

Contact Timeline

Deal events are injected into the Mautic contact timeline for associated contacts. This gives your team visibility into deal activity from the contact record, without switching views.

Email Personalization

Use deal tokens in Mautic email templates to personalize outreach for contacts associated with deals:

Campaigns

Deal Flow integrates natively with Mautic's campaign builder, adding deal-aware conditions, actions, and segment filters.

Campaign Conditions

Campaign Actions

Segment Filters

Reports & Metrics

Access the reports dashboard at Deal Flow → Reports.

Key Metrics

Owner Leaderboard

Ranks deal owners by total pipeline value, deals won, and win rate. Useful for sales team performance reviews.

At-Risk Deals

Lists deals that have exceeded risk thresholds (days in stage). Sorted by severity — red indicators first, then yellow.

Dashboard Widgets

Deal Flow provides dashboard widgets that can be added to your Mautic home dashboard. Go to Dashboard → Add Widget and select from:

API Reference

Deal Flow exposes a REST API under the /api/dealflow/ namespace. All endpoints require Mautic API authentication (OAuth2 or Basic Auth).

Deal Endpoints

Example: Create a Note

curl -X POST https://mautic.example.com/api/dealflow/deals/42/notes \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "body": "Proposal sent to procurement team.",
    "activity_type": "note"
  }'

Example: Move Stage

curl -X POST https://mautic.example.com/api/dealflow/deals/42/stage \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{"stage_id": 5}'

Example: Associate Contact

curl -X POST https://mautic.example.com/api/dealflow/deals/42/contacts \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "contact_id": 108,
    "label": "Decision Maker"
  }'

For complete API documentation including request/response schemas, see the Webhooks and FAQ sections below.

Webhooks

Inbound Webhooks

Receive deal data from external systems via inbound webhook sources. Each source gets a unique URL and optional HMAC signing for request verification.

Setting Up an Inbound Source

1. Go to Deal Flow → Webhooks → New Source
2. Name the source (e.g., "Typeform Submissions")
3. Copy the generated webhook URL
4. Optionally set an HMAC secret for request signing
5. Configure field mapping: map source JSON fields to deal fields

HMAC Verification

When an HMAC secret is configured, Deal Flow verifies inbound requests by computing HMAC-SHA256 of the request body and comparing it to the X-Signature header.

# Compute the expected signature
echo -n '{"title":"New Deal","amount":5000}' | \
  openssl dgst -sha256 -hmac "your-webhook-secret"

Outbound Webhooks

Deal Flow fires events through Mautic's native webhook system. Configure outbound webhooks in Mautic Settings → Webhooks and subscribe to Deal Flow events:

• dealflow.deal.created — New deal created
• dealflow.deal.updated — Deal fields updated
• dealflow.deal.stage_changed — Deal moved to a new stage
• dealflow.deal.won — Deal marked as won
• dealflow.deal.lost — Deal marked as lost
• dealflow.deal.contact_added — Contact associated with deal

FAQ

What version of Mautic is required?

Deal Flow requires Mautic 5.x running on PHP 8.1 or higher.

Is this a CRM replacement?

No. Deal Flow is a Revenue Operations plugin. It adds deal and pipeline management to Mautic — it does not replace Mautic's contact management, campaigns, or marketing features. It enhances them.

How is this different from other Mautic CRM plugins?

Buying Committee Intelligence. Most deal trackers associate one contact per deal. Deal Flow lets you map entire buying committees with role labels, giving you visibility into multi-stakeholder deals.

What happens when my renewal expires?

The plugin continues to work. You lose access to updates and support. Your data is never locked or deleted.

Is there a free tier?

No. Deal Flow is a commercial plugin priced at $149 one-time with a $49/year renewal for updates and support. No free tier, no feature gates — all customers get all features.

Can I use custom fields?

Yes. Deal Flow supports custom fields via the DealField entity. Add text, number, select, and date fields through the configuration screen.

How do I upgrade?

wget https://dealflowplugin.com/download/DealFlowBundle.zip
unzip -o DealFlowBundle.zip -d plugins/
sudo -u www-data php bin/console cache:clear --no-warmup
sudo -u www-data php bin/console cache:warmup
sudo -u www-data php bin/console mautic:plugins:reload

Where do I get support?

Email support@dealflowplugin.com.

What is the license?

Deal Flow is a commercial plugin. Purchase includes a perpetual per-subdomain license with 1 year of updates.