docs: Add Tags documentation for Contact management by promptless-for-oss · Pull Request #647 · mautic/user-documentation

promptless-for-oss · 2026-02-24T09:55:30Z

Open this suggestion in Promptless to view citations and reasoning process

Creates comprehensive documentation for Tags in Mautic. The new tags.rst page covers creating and managing Tags, adding Tags to Contacts manually and via batch updates, using Tags in Campaigns (Modify Contact's Tags action, Contact Tags condition), using Tags in Forms and Segments, Tag search syntax, and best practices for Tag taxonomy.

Trigger Events

Web UI: Can you check if there is any missing documentation

Agent Response

I've completed a comprehensive review of the Mautic documentation and identified three key documentation gaps. I've created documentation suggestions to address each one:

Summary of Documentation Gaps Found and Addressed

1. Tags Documentation (New Page) ✅

Gap Found: Tags are used throughout Mautic (Campaigns, Forms, Segments) but there was no dedicated documentation explaining what Tags are or how to use them.

Created: New docs/contacts/tags.rst covering:

What Tags are and how they differ from Segments

Creating and managing Tags

Using Tags in Campaigns (Modify Contact's Tags action, Contact Tags condition)

Using Tags in Forms

Using Tags as Segment filters

Tag search syntax

Best practices for Tag taxonomy

2. Webhooks Documentation (New Page) ✅

Gap Found: Webhooks are mentioned in cron jobs and settings, but there was no documentation explaining how to actually create and configure Webhooks.

Created: New docs/configuration/webhooks.rst covering:

Creating and configuring Webhooks

All available Webhook events (Contact, Email, Form, Page)

Example JSON payload structure

Global Webhook settings and queue mode

Cron job setup for queued Webhooks

Troubleshooting common issues

Performance and security considerations

3. A/B Testing Documentation (Enhanced Section) ✅

Gap Found: A/B testing was only briefly mentioned in the Emails documentation (just about previewing variants), with no comprehensive guide.

Enhanced: Added comprehensive A/B testing section to docs/channels/emails.rst covering:

Step-by-step setup instructions

What elements to test (subject lines, sender name, content, images, CTAs)

How to analyze A/B test results

Best practices for effective testing

Features That Were Already Well Documented

My review also confirmed these areas are adequately documented:

Point Groups, Event cloning, Export permissions, Custom fonts in GrapesJS

SAML/SSO authentication, Do Not Contact

...truncated. See dashboard for full response.

Tip: Set up a GitHub Issues trigger in Projects to enable @Promptless mentions in issues 🐙

Signed-off-by: promptless-for-oss <promptless-for-oss@users.noreply.github.com>

promptless-for-oss · 2026-02-24T09:55:32Z

@@ -0,0 +1,125 @@
+.. vale off


Citation: Referenced Modify Contact's tags action and Contact Tags condition from the Campaign Builder documentation to ensure consistency in describing Tags usage within Campaigns.
View source

promptless-for-oss · 2026-02-24T09:55:34Z

@@ -0,0 +1,125 @@
+.. vale off


Citation: Referenced the Modify Contact's Tags Form action documentation to ensure consistency in describing Tags usage within Forms.
View source

RCheesley

Looks good!

adiati98

@promptless-for-oss there are some reviews for you to address.

adiati98 · 2026-04-03T15:30:42Z

+Managing Tags
+*************


Let's wrap this in vale off and vale on.

Suggested change

Managing Tags

*************

.. vale off

Managing Tags

*************

.. vale on

adiati98 · 2026-04-03T15:31:39Z

+Creating Tags
+=============


Suggested change

Creating Tags

=============

.. vale off

Creating Tags

=============

.. vale on

adiati98 · 2026-04-03T15:31:56Z

+Adding Tags to Contacts
+=======================


Suggested change

Adding Tags to Contacts

=======================

.. vale off

Adding Tags to Contacts

=======================

.. vale on

adiati98 · 2026-04-03T15:34:23Z

+Using Tags in Campaigns
+***********************


Suggested change

Using Tags in Campaigns

***********************

.. vale off

Using Tags in Campaigns

***********************

.. vale on

adiati98 · 2026-04-03T15:34:55Z

+4. Select Tags to add or remove.
+5. Click **Add** to save the action.
+
+This action is useful for marking Contacts who have reached certain stages, completed specific actions, or require follow-up.


Suggested change

This action is useful for marking Contacts who have reached certain stages, completed specific actions, or require follow-up.

.. vale off

This action is useful for marking Contacts who have reached certain stages, completed specific actions, or require follow-up.

.. vale on

adiati98 · 2026-04-03T15:45:21Z

+- To find Contacts with a specific Tag, use: ``tag:tagname``
+- To find Contacts without a specific Tag, use: ``!tag:tagname``


We use * for unordered list.

Suggested change

- To find Contacts with a specific Tag, use: ``tag:tagname``

- To find Contacts without a specific Tag, use: ``!tag:tagname``

* To find Contacts with a specific Tag, use ``tag:tagname``

* To find Contacts without a specific Tag, use ``!tag:tagname``

adiati98 · 2026-04-03T15:47:08Z

+- **Use consistent naming conventions** - Establish naming rules to avoid duplicates like "Webinar" and "webinar-attendee" for similar purposes.
+- **Document your Tag taxonomy** - Keep a record of what each Tag means and when to use it.
+- **Avoid over-tagging** - Too many Tags can become difficult to manage. Consider whether a Segment or Custom Field might be more appropriate.
+- **Review Tags regularly** - Periodically audit your Tags to remove outdated or unused ones.
+- **Combine with Segments** - Use Tags for quick manual labeling and Segments for dynamic, filter-based grouping.


Use single quote for word(s) and double quotes for quotes.

Suggested change

- **Use consistent naming conventions** - Establish naming rules to avoid duplicates like "Webinar" and "webinar-attendee" for similar purposes.

- **Document your Tag taxonomy** - Keep a record of what each Tag means and when to use it.

- **Avoid over-tagging** - Too many Tags can become difficult to manage. Consider whether a Segment or Custom Field might be more appropriate.

- **Review Tags regularly** - Periodically audit your Tags to remove outdated or unused ones.

- **Combine with Segments** - Use Tags for quick manual labeling and Segments for dynamic, filter-based grouping.

* **Use consistent naming conventions** - Establish naming rules to avoid duplicates, such as 'Webinar' and 'webinar-attendee', for similar purposes.

* **Document your Tag taxonomy** - Keep a record of what each Tag means and when to use it.

* **Avoid over-tagging** - Too many Tags can become difficult to manage. Consider whether a Segment or Custom Field might be more appropriate.

* **Review Tags regularly** - Periodically audit your Tags to remove outdated or unused ones.

* **Combine with Segments** - Use Tags for quick manual labeling and Segments for dynamic, filter-based grouping.

adiati98 · 2026-04-03T15:48:05Z

+- To find Contacts with a specific Tag, use: ``tag:tagname``
+- To find Contacts without a specific Tag, use: ``!tag:tagname``
+
+Replace ``tagname`` with the actual name of the Tag. If the Tag name contains spaces, wrap it in quotes: ``tag:"tag name"``


Let's stay away from : when possible.

Suggested change

Replace ``tagname`` with the actual name of the Tag. If the Tag name contains spaces, wrap it in quotes: ``tag:"tag name"``

Replace ``tagname`` with the actual name of the Tag. If the Tag name contains spaces, wrap it in quotes. For example, ``tag:"tag name"``.

adiati98 · 2026-04-03T15:48:42Z

+1. Navigate to the **Contacts** section.
+2. Use filters to find the Contacts you want to update.
+3. Select the checkboxes next to the desired Contacts.
+4. Click the green arrow at the top of the column.
+5. Select **Change Tags** from the dropdown menu.
+6. Choose Tags to add or remove.
+7. Click **Save**.


Suggested change

1. Navigate to the **Contacts** section.

2. Use filters to find the Contacts you want to update.

3. Select the checkboxes next to the desired Contacts.

4. Click the green arrow at the top of the column.

5. Select **Change Tags** from the dropdown menu.

6. Choose Tags to add or remove.

7. Click **Save**.

#. Navigate to the **Contacts** section.

#. Use filters to find the Contacts you want to update.

#. Select the checkboxes next to the desired Contacts.

#. Click the green arrow at the top of the column.

#. Select **Change Tags** from the dropdown menu.

#. Choose Tags to add or remove.

#. Click **Save**.

adiati98 · 2026-04-03T15:49:55Z

+1. Navigate to the Contact's record.
+2. Click **Edit** to open the Contact edit form.
+3. In the **Tags** field, start typing to search existing Tags or enter a new Tag name.
+4. Press Enter or select from the dropdown to apply the Tag.
+5. Click **Save** to save the changes.


The word "form" here is general, not Mautic's feature. So, let's wrap this in vale off/on.

Suggested change

1. Navigate to the Contact's record.

2. Click **Edit** to open the Contact edit form.

3. In the **Tags** field, start typing to search existing Tags or enter a new Tag name.

4. Press Enter or select from the dropdown to apply the Tag.

5. Click **Save** to save the changes.

.. vale off

#. Navigate to the Contact's record.

#. Click **Edit** to open the Contact edit form.

#. In the **Tags** field, start typing to search existing Tags or enter a new Tag name.

#. Press Enter or select from the dropdown to apply the Tag.

#. Click **Save** to save the changes.

.. vale on

Add Tags documentation for Contact management

a71ccce

Signed-off-by: promptless-for-oss <promptless-for-oss@users.noreply.github.com>

promptless-for-oss requested a review from a team as a code owner February 24, 2026 09:55

promptless-for-oss requested review from adiati98 and favour-chibueze and removed request for a team February 24, 2026 09:55

promptless-for-oss commented Feb 24, 2026

View reviewed changes

RCheesley approved these changes Apr 3, 2026

View reviewed changes

adiati98 requested changes Apr 3, 2026

View reviewed changes

Merge branch '5.2' into promptless/add-tags-documentation

1fb72ee

		- To find Contacts with a specific Tag, use: ``tag:tagname``
		- To find Contacts without a specific Tag, use: ``!tag:tagname``

	Replace ``tagname`` with the actual name of the Tag. If the Tag name contains spaces, wrap it in quotes: ``tag:"tag name"``
	Replace ``tagname`` with the actual name of the Tag. If the Tag name contains spaces, wrap it in quotes. For example, ``tag:"tag name"``.

Conversation

promptless-for-oss commented Feb 24, 2026

Trigger Events

Summary of Documentation Gaps Found and Addressed

1. Tags Documentation (New Page) ✅

2. Webhooks Documentation (New Page) ✅

3. A/B Testing Documentation (Enhanced Section) ✅

Features That Were Already Well Documented

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

RCheesley left a comment

Choose a reason for hiding this comment

Uh oh!

adiati98 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants