diff --git a/.github/styles/Mautic/FeatureList.yml b/.github/styles/Mautic/FeatureList.yml index 1a4dff00..a83f4872 100644 --- a/.github/styles/Mautic/FeatureList.yml +++ b/.github/styles/Mautic/FeatureList.yml @@ -45,6 +45,8 @@ swap: point actions: Point Actions point triggers: Point Triggers points: Points + group: Group + groups: Groups plugin: Plugin plugins: Plugins report: Report diff --git a/docs/campaigns/campaign_builder.rst b/docs/campaigns/campaign_builder.rst index 0f4781bc..ce629ed3 100644 --- a/docs/campaigns/campaign_builder.rst +++ b/docs/campaigns/campaign_builder.rst @@ -58,7 +58,7 @@ The actions that Mautic offers in a Campaign include: * - **Add Company action** - Associates a Contact with a Company and sets the Company as the primary Company for the Contact. * - **Adjust Contact Points** - - Adds or subtracts Points from the Contact’s Point total. + - Adds or subtracts Points from the Contact’s Point total or Group. * - **Change Campaigns** - Removes a Contact from the existing Campaign, moves them into another Campaign, restarts the current Campaign or a combination of these. You must remove a Contact from a Campaign before restarting the Campaign. * - **Change Contact's Stage** @@ -205,6 +205,8 @@ Here are the different conditions that Mautic offers in the Campaign Builder: - Checks if the Contact is a member of selected Segments. * - **Contact Tags** - Checks if specified Tags are on the Contact record. + * - **Contact points** + - Checks if the Contact has a certain number of Points or a Group score. * - **Form field value** - Checks if values submitted for a selected field on a selected Form matches specified criteria. * - **Has active notification** diff --git a/docs/index.rst b/docs/index.rst index c0d11d80..e309c13f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -180,6 +180,7 @@ There are different types of documentation available to help you navigate your w points/points points/points_troubleshooting + points/point_groups .. toctree:: :maxdepth: 2 diff --git a/docs/points/images/campaign-point-action-with-group.png b/docs/points/images/campaign-point-action-with-group.png new file mode 100644 index 00000000..4a8a6837 Binary files /dev/null and b/docs/points/images/campaign-point-action-with-group.png differ diff --git a/docs/points/images/campaign-point-condition-with-group.png b/docs/points/images/campaign-point-condition-with-group.png new file mode 100644 index 00000000..ab76c08d Binary files /dev/null and b/docs/points/images/campaign-point-condition-with-group.png differ diff --git a/docs/points/images/contact-group-points.png b/docs/points/images/contact-group-points.png new file mode 100644 index 00000000..ce3ffc43 Binary files /dev/null and b/docs/points/images/contact-group-points.png differ diff --git a/docs/points/images/form-action-with-point-group.png b/docs/points/images/form-action-with-point-group.png new file mode 100644 index 00000000..ece1bd7a Binary files /dev/null and b/docs/points/images/form-action-with-point-group.png differ diff --git a/docs/points/images/group-report.png b/docs/points/images/group-report.png new file mode 100644 index 00000000..66f28449 Binary files /dev/null and b/docs/points/images/group-report.png differ diff --git a/docs/points/images/new-group.png b/docs/points/images/new-group.png new file mode 100644 index 00000000..26a185fe Binary files /dev/null and b/docs/points/images/new-group.png differ diff --git a/docs/points/images/point-action-with-group.png b/docs/points/images/point-action-with-group.png new file mode 100644 index 00000000..c64c64f4 Binary files /dev/null and b/docs/points/images/point-action-with-group.png differ diff --git a/docs/points/images/point-trigger-with-group.png b/docs/points/images/point-trigger-with-group.png new file mode 100644 index 00000000..5edd0c14 Binary files /dev/null and b/docs/points/images/point-trigger-with-group.png differ diff --git a/docs/points/images/segment-group-filter-element.png b/docs/points/images/segment-group-filter-element.png new file mode 100644 index 00000000..7f59fa05 Binary files /dev/null and b/docs/points/images/segment-group-filter-element.png differ diff --git a/docs/points/images/segment-group-filter.png b/docs/points/images/segment-group-filter.png new file mode 100644 index 00000000..e3f38362 Binary files /dev/null and b/docs/points/images/segment-group-filter.png differ diff --git a/docs/points/point_groups.rst b/docs/points/point_groups.rst new file mode 100644 index 00000000..233606e5 --- /dev/null +++ b/docs/points/point_groups.rst @@ -0,0 +1,93 @@ +.. vale off + +Point Groups +############# + +.. vale on + +Point Groups is a feature that allows users to categorize the score of their Contacts. By setting up Point Groups, users can assign a specific number of Points to each action taken by a Contact, such as opening an Email, visiting a Landing page, or downloading an Asset. + +Managing Point Groups +====================== +To access the currently defined Point Groups in Mautic, navigate to the Points Menu and click the "Manage Groups" link. To create a new Group, simply click the "New" button. + +.. image:: images/new-group.png + :width: 600 + :alt: Screenshot of the create a new Group interface + +Enter a name and a description for the Group and click the "Save & Close" button to create the Group. + +Point Groups usage +=================== + +Point actions +------------- +You can change Contact's Points within a Points Group by using Points Actions. + +.. image:: images/point-action-with-group.png + :width: 600 + :alt: Screenshot of Points action with Group + +Point triggers +-------------- +You can use Point triggers based on Point Groups to automatically trigger specific events within the system. + +.. image:: images/point-trigger-with-group.png + :width: 600 + :alt: Screenshot of Points trigger with Group + +Campaign condition +------------------ +You can use a condition based on Group Contact score in a Campaign. + +.. image:: images/campaign-point-condition-with-group.png + :width: 600 + :alt: Screenshot of Points trigger with Group + +Campaign action +--------------- +You can use a Campaign action to increase or decrease the Group Contact score. + +.. image:: images/campaign-point-action-with-group.png + :width: 600 + :alt: Screenshot of Campaign Point action with Group + +Form action +--------------- +You can use a Form action to increase or decrease the Group Contact score. + +.. image:: images/form-action-with-point-group.png + :width: 600 + :alt: Screenshot of Form Adjust contact's points action with Group + +Segment filters +--------------- +Each Point Group adds a new filter that can be used to configurate the Segment. + +.. image:: images/segment-group-filter.png + :width: 600 + :alt: Screenshot of Segment Group filter + +.. image:: images/segment-group-filter-element.png + :width: 600 + :alt: Screenshot of Segment Group filter element + +Contact details +--------------- +You can display Point Groups in the Contact details. + +.. image:: images/contact-group-points.png + :width: 600 + :alt: Screenshot of Contact Details with Group Points + +Group Report +------------- +You can generate a Report that contains information about Contact Point Groups. + +.. image:: images/group-report.png + :width: 600 + :alt: Screenshot of Group Report + +Webhooks +-------- +Changing the Contact Group Points will not trigger the Contact Points Changed Event Webhook \ No newline at end of file diff --git a/docs/reports/reports.rst b/docs/reports/reports.rst index 72f43d0e..d3aa3bdd 100644 --- a/docs/reports/reports.rst +++ b/docs/reports/reports.rst @@ -60,6 +60,7 @@ The **Details** tab on a Report contains the same options across all Reports and * Segment Membership * Do Not Contact * UTM Codes + * Group score 7. :doc:`Companies`