Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
37 changes: 30 additions & 7 deletions docs/points/points.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,25 +15,29 @@ Point Actions are those times when a Contact receives a change in their Point to

To add a new action:

1. Click **Points > Point Actions > + New** - located in the top right corner.
1. Click **Points > Manage Actions > + New** - located in the top right corner.

.. image:: images/points-action.png
:alt: Screenshot of Points action

2. In the main panel, there are four boxes for key information. Enter the appropriate information.
2. In the main panel, there are five boxes for key information. Enter the appropriate information.

* **Name** - The name of your action. This is how the action displays in your list of actions, so choose an identifiable name.

* **Description** - Add a description to help you find certain actions. There may be more actions which are similar or more in-depth.

* **Change Points (+/-)** - The value change to set for the action. The ``+`` isn't necessary when adding Points. When subtracting Points, add the ``-`` symbol.

* **Actions taken by User** - This is the behavior or action the Contact must complete to trigger the action.
* **Actions taken by contact** - This is the behavior or action the Contact must complete to trigger the action.

* **Point group** - This is the point group you want the action to be applied to.

3. On the right side is more information:

* **Category** - Organize your Point Actions based on their goals, Campaigns, etc. For more information, see :doc:`Categories</categories/categories-overview>`. All Points accumulate on a Contact record, regardless of Category. There is one Points score for each Contact.

* **Projects** - Organize your Point Actions based on their Campaigns project.

* **Active and Activate/Deactivate at date/time** - Once you have a Point action, Mautic awards Points when a Contact completes the action. Points aren't given for inactive actions. If you have target behaviors that you want to award Points for within a certain time period, you can set the activate and deactivate dates

* **Is repeatable** - To award Points each time a Contact completes an action, select **Yes**. If you want to award Points **only** the first time someone completes the action, select **No** - this is the default.
Expand All @@ -49,10 +53,14 @@ Point Triggers

Once a Contact has accumulated a Point total, you may want to trigger an action with the Contact. You may create multiple triggers for different Point values.

To add a new trigger:

1. Click **Points > Manage Triggers > + New** - located in the top right corner. This opens in the **Details** tab.

.. image:: images/points-trigger.png
:alt: Screenshot of Points trigger

Creating Point Triggers is like creating Point Actions. The **Name**, **Description**, **Category**, and **Active** options are all the same. The trigger fires based on the minimum number of Points. Set a number and decide if you want to **Trigger for existing applicable Contacts upon saving - if activated**.
Creating Point Triggers is like creating Point Actions. The **Name**, **Description**, **Point group**, **Category**, **Projects** and **Active** options are all the same. The trigger fires based on the minimum number of Points. Set a number and decide if you want to **Trigger for existing applicable Contacts upon saving - if activated**.

Once you have decided and entered those options, go to the **Events** tab. Here, you can trigger one or more events once a Contact has reached your predetermined Point total. These Point Triggers and associated events are also fully customizable.

Expand All @@ -64,18 +72,30 @@ Campaign triggers

**Modify Contact's Campaigns** - Add a Contact to or remove a Contact from any Campaigns you have activated.

.. image:: images/point-trigger-modify-contacts-campaigns.png
:alt: Screenshot of Points trigger modify contact's campaigns event

Contact triggers
================

**Modify Contact's Segments** - Add a Contact to or remove a Contact from any Segments you have activated.

.. image:: images/point-trigger-modify-contacts-segment.png
:alt: Screenshot of Points trigger modify contact's segment event

**Modify Contact's tags** - Add or remove any Tags on the Contact record. If a Tag doesn't exist, you may create a new one in the edit window for this event.

.. image:: images/point-trigger-modify-contact-tags.png
:alt: Screenshot of Points trigger modify contact's tags event

Add-on triggers
===============

**Push Contact to Integration** - To only push Contacts to an Integration after hitting a minimum Point total, use this option. You must have the **Triggered action push Contacts to Integration** option selected in the Integration. After selecting this event, the system displays a dialog box where you can choose which Integration to push the Contact to. For example, if you base your definition of a Marketing Qualified Lead (MQL) on Point values, you may decide to only push Contacts who are MQLs to your CRM. Once a Contact meets the Points requirement to be an MQL, use this action to push the Contact to your CRM.

.. image:: images/point-trigger-push-contact-to-integration.png
:alt: Screenshot of Points trigger push contact to integration event

.. note::

The Push Contact to Integration action isn't supported with the Salesforce Plugin.
Expand All @@ -85,8 +105,8 @@ Email triggers

**Send an Email** - Send a template Email to the Contact based on their engagement. This may be some sort of special offer, congratulations, etc.

.. image:: images/send-an-email-to-user.png
:alt: Screenshot of Send an Email to User Email trigger
.. image:: images/point-trigger-send-an-email.png
:alt: Screenshot of Send an Email trigger

**Send an Email to User** - Tell a team member that a Contact has reached a minimum number of Points. There is an option in this event to send the Email to the Contact's owner. You may either write a basic Email in the editor, or use a template Email.
* Selecting a User and selecting the option of **send Email to Contact's owner** notifies both Contacts.
Expand All @@ -95,4 +115,7 @@ Email triggers

* You can add more Emails to 'to', 'cc' and 'bcc' fields - separated by a comma. You can add space after each comma if needed.

* Sends Notification to all address - User's Email, owner's Email, to, cc and bcc.
* Sends Notification to all address - User's Email, owner's Email, to, cc and bcc.

.. image:: images/send-an-email-to-user.png
:alt: Screenshot of Send an Email to User Email trigger