Personal tools
Namespaces

Variants
Actions

Marketing Triggers Automation For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Migration Guide)
 
(12 intermediate revisions by one user not shown)
Line 1: Line 1:
 
<meta name="keywords" content="marketing triggers automation for whmcs, whmcs marketing triggers automation configuration, whmcs marketing triggers automation management, whmcs marketing triggers automation installation, whmcs marketing triggers automation common problems, about whmcs marketing triggers automation, whmcs marketing triggers automation documentation, whmcs marketing triggers automation faq, whmcs marketing triggers automation help, whmcs marketing triggers automation guide, whmcs marketing triggers automation wiki, whmcs marketing triggers automation tutorial, whmcs marketing triggers automation tips"></meta>
 
<meta name="keywords" content="marketing triggers automation for whmcs, whmcs marketing triggers automation configuration, whmcs marketing triggers automation management, whmcs marketing triggers automation installation, whmcs marketing triggers automation common problems, about whmcs marketing triggers automation, whmcs marketing triggers automation documentation, whmcs marketing triggers automation faq, whmcs marketing triggers automation help, whmcs marketing triggers automation guide, whmcs marketing triggers automation wiki, whmcs marketing triggers automation tutorial, whmcs marketing triggers automation tips"></meta>
 
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Marketing Triggers Automation For WHMCS Module."></meta>
 
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Marketing Triggers Automation For WHMCS Module."></meta>
−
 
−
<h4 style="color: #ff0000; font-weight:bold; text-align:center;">This article is currently being updated, so you might notice missing images, incomplete sections, or temporarily broken links. <br/>Thanks for your patience while we get everything up to date!
 
−
</h4>
 
  
 
=About [https://www.modulesgarden.com/products/whmcs/marketing-triggers-automation Marketing Triggers Automation For WHMCS]=
 
=About [https://www.modulesgarden.com/products/whmcs/marketing-triggers-automation Marketing Triggers Automation For WHMCS]=
Line 523: Line 520:
 
=Management=
 
=Management=
 
{|
 
{|
−
|style="padding: 10px 0px 5px 15px;"|'''Marketing Triggers Automation For WHMCS lets you automate tasks based on customer actions and triggered in your WHMCS processes.'''  
+
|style="padding: 10px 0px 30px 15px;"|'''Marketing Triggers Automation For WHMCS lets you automate tasks based on customer actions and triggered in your WHMCS processes.'''  
 
In this guide, we will walk you through the management features of the module.
 
In this guide, we will walk you through the management features of the module.
 
|}
 
|}
Line 542: Line 539:
 
*'''Trigger''' - which of the triggers launched the action.
 
*'''Trigger''' - which of the triggers launched the action.
 
*'''Action''' - which of the actions was triggered.
 
*'''Action''' - which of the actions was triggered.
−
*'''Status''' - the event status: "Pending", "Finished", "Error" and "Ready".<br/>'''''Note:''' The 'Ready' status indicates that an action is prepared and waiting for the customer,'
+
*'''Status''' - the event status: "Pending", "Finished", "Error" and "Ready".<br/>'''''Note:''' The "Ready" status indicates that an action is prepared and waiting for the customer.''
 
|}
 
|}
 
{|
 
{|
Line 585: Line 582:
 
If you want, you can use merge fields, they can be found below the action form. Find the trigger you plan to use to see merge fields available for it.
 
If you want, you can use merge fields, they can be found below the action form. Find the trigger you plan to use to see merge fields available for it.
 
* '''Action Name''' - name the action, this will help identify it when creating a trigger later.
 
* '''Action Name''' - name the action, this will help identify it when creating a trigger later.
 +
* '''Action Access Mode''' - Select which clients can trigger the action:
 +
** '''Disabled - No restrictions; the action will run for all clients.
 +
** '''Blacklist''' - The action will be blocked for clients in the selected customer group; all others are allowed.
 +
** '''Whitelist''' - Only clients in the selected customer group are allowed to trigger the action; all others are blocked.
 +
*'''[[#Customer_Groups|Customer Groups]]''' - Choose which client groups to include or exclude when the action runs, depending on the selected Action Access Mode.
 
* '''Title''' - enter a title, it will be used to name the to-do item.
 
* '''Title''' - enter a title, it will be used to name the to-do item.
 
* '''Description''' - provide a description for the to-do item.
 
* '''Description''' - provide a description for the to-do item.
Line 600: Line 602:
 
* '''Action Name''' - Name the action, this will help identify it when creating a trigger later.
 
* '''Action Name''' - Name the action, this will help identify it when creating a trigger later.
  
−
* 'Action Access Mode''' - Select which clients can trigger the action:
+
* '''Action Access Mode''' - Select which clients can trigger the action:
 
** '''Disabled - No restrictions; the action will run for all clients.
 
** '''Disabled - No restrictions; the action will run for all clients.
 
** '''Blacklist''' - The action will be blocked for clients in the selected customer group; all others are allowed.
 
** '''Blacklist''' - The action will be blocked for clients in the selected customer group; all others are allowed.
 
** '''Whitelist''' - Only clients in the selected customer group are allowed to trigger the action; all others are blocked.
 
** '''Whitelist''' - Only clients in the selected customer group are allowed to trigger the action; all others are blocked.
  
−
*'''Customer Groups''' - Choose which client groups to include or exclude when the action runs, depending on the selected Action Access Mode.
+
*'''[[#Customer_Groups|Customer Groups]]''' - Choose which client groups to include or exclude when the action runs, depending on the selected Action Access Mode.
 
* '''Email Recipient''' - Select which admins will receive the email, the Triggering Admin, is the admin that is responsible for triggering the event.
 
* '''Email Recipient''' - Select which admins will receive the email, the Triggering Admin, is the admin that is responsible for triggering the event.
 
* '''Email Template''' - Select the [https://docs.whmcs.com/system/email/email-templates/ email template] that will be used for the action.
 
* '''Email Template''' - Select the [https://docs.whmcs.com/system/email/email-templates/ email template] that will be used for the action.
Line 616: Line 618:
 
{|
 
{|
 
|style="padding: 10px 0px 15px 15px;"|Send an email to clients when they trigger the action. This is useful for keeping clients informed or confirming actions they have initiated.
 
|style="padding: 10px 0px 15px 15px;"|Send an email to clients when they trigger the action. This is useful for keeping clients informed or confirming actions they have initiated.
 +
 +
'''General sections:'''
 
* '''Action Name''' - name the action, this will help identify it when creating a trigger later.
 
* '''Action Name''' - name the action, this will help identify it when creating a trigger later.
 +
* '''Action Access Mode''' - Select which clients can trigger the action:
 +
** '''Disabled - No restrictions; the action will run for all clients.
 +
** '''Blacklist''' - The action will be blocked for clients in the selected customer group; all others are allowed.
 +
** '''Whitelist''' - Only clients in the selected customer group are allowed to trigger the action; all others are blocked.
 +
 +
*'''[[#Customer_Groups|Customer Groups]]''' - Choose which client groups to include or exclude when the action runs, depending on the selected Action Access Mode.
 +
 +
'''Dedicated sections:'''
 
* '''Email Template''' - select the [https://docs.whmcs.com/system/email/email-templates/ email template] that will be used for the action.
 
* '''Email Template''' - select the [https://docs.whmcs.com/system/email/email-templates/ email template] that will be used for the action.
 
* '''Mark as Marketing Email''' - If enabled, this email notification will be classified as a marketing message, and customers who have '''opted out of marketing emails''' will not receive it.<br/>If the option is disabled, the email will be sent regardless of the customer's marketing preferences. <br/> '''''Note:''' If WHMCS has the "Marketing Emails" feature completely disabled in its settings, all notifications will be delivered regardless of the switch status.''
 
* '''Mark as Marketing Email''' - If enabled, this email notification will be classified as a marketing message, and customers who have '''opted out of marketing emails''' will not receive it.<br/>If the option is disabled, the email will be sent regardless of the customer's marketing preferences. <br/> '''''Note:''' If WHMCS has the "Marketing Emails" feature completely disabled in its settings, all notifications will be delivered regardless of the switch status.''
Line 626: Line 638:
 
===Open Support Ticket===
 
===Open Support Ticket===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|This action will create an open [https://docs.whmcs.com/support/support-tickets/ support ticket] for the customer that triggers it.<br/>It helps automate the process of addressing customer issues by automatically generating a ticket for prompt follow-up.
+
|style="padding: 10px 0px 15px 15px;"|This action will create an open [https://docs.whmcs.com/support/support-tickets/ support ticket] for the customer that triggers it.<br/>It helps automate the process of addressing customer issues by automatically generating a ticket for prompt follow-up.<br/>
 +
'''General sections:'''
 
* '''Action Name''' - name the action, this will help identify it when creating a trigger later.
 
* '''Action Name''' - name the action, this will help identify it when creating a trigger later.
 +
* '''Action Access Mode''' - Select which clients can trigger the action:
 +
** '''Disabled - No restrictions; the action will run for all clients.
 +
** '''Blacklist''' - The action will be blocked for clients in the selected customer group; all others are allowed.
 +
** '''Whitelist''' - Only clients in the selected customer group are allowed to trigger the action; all others are blocked.
 +
 +
*'''[[#Customer_Groups|Customer Groups]]''' - Choose which client groups to include or exclude when the action runs, depending on the selected Action Access Mode.
 +
<br/>
 +
'''Dedicated sections:'''
 
* '''Department''' - select the department to assign the ticket to.
 
* '''Department''' - select the department to assign the ticket to.
 
* '''Assigned Admin''' - select the admin that will be assigned to the ticket.
 
* '''Assigned Admin''' - select the admin that will be assigned to the ticket.
Line 646: Line 667:
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|Send an SMS message to selected admins. This can be used to notify admins about important updates or actions that require their attention via SMS.
 
|style="padding: 0px 0px 15px 15px;"|Send an SMS message to selected admins. This can be used to notify admins about important updates or actions that require their attention via SMS.
 +
<br/>
 +
'''General sections:'''
 +
 
* '''Action Name''' - name the action, this will help identify it when creating a trigger later.
 
* '''Action Name''' - name the action, this will help identify it when creating a trigger later.
 +
* '''Action Access Mode''' - Select which clients can trigger the action:
 +
** '''Disabled - No restrictions; the action will run for all clients.
 +
** '''Blacklist''' - The action will be blocked for clients in the selected customer group; all others are allowed.
 +
** '''Whitelist''' - Only clients in the selected customer group are allowed to trigger the action; all others are blocked.
 +
*'''[[#Customer_Groups|Customer Groups]]''' - Choose which client groups to include or exclude when the action runs, depending on the selected Action Access Mode.
 +
 +
'''Dedicated sections:'''
 +
 
* '''API Execution Admin''' - select which admin will be used to execute the API.
 
* '''API Execution Admin''' - select which admin will be used to execute the API.
 
* '''Notified Admins''' - select which admins will receive the message. '' 'Triggering Admin' '' is the admin that has triggered the action.
 
* '''Notified Admins''' - select which admins will receive the message. '' 'Triggering Admin' '' is the admin that has triggered the action.
Line 663: Line 695:
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|Send an SMS message to the triggering client. This allows you to quickly notify the client via SMS about important updates or actions they have initiated.
 
|style="padding: 0px 0px 15px 15px;"|Send an SMS message to the triggering client. This allows you to quickly notify the client via SMS about important updates or actions they have initiated.
 +
 +
'''General sections:'''
 
* '''Action Name''' - give the action a name to help you identify it when setting up a trigger later.
 
* '''Action Name''' - give the action a name to help you identify it when setting up a trigger later.
 +
* '''Action Access Mode''' - Select which clients can trigger the action:
 +
** '''Disabled - No restrictions; the action will run for all clients.
 +
** '''Blacklist''' - The action will be blocked for clients in the selected customer group; all others are allowed.
 +
** '''Whitelist''' - Only clients in the selected customer group are allowed to trigger the action; all others are blocked.
 +
*'''[[#Customer_Groups|Customer Groups]]''' - Choose which client groups to include or exclude when the action runs, depending on the selected Action Access Mode.
 +
 +
'''Dedicated sections:'''
 
* '''API Execution Admin''' - choose the admin who will execute the API for this action.
 
* '''API Execution Admin''' - choose the admin who will execute the API for this action.
 
* '''Mark as Marketing SMS''' - If enabled, this SMS will be classified as a marketing message:<br/>
 
* '''Mark as Marketing SMS''' - If enabled, this SMS will be classified as a marketing message:<br/>
Line 680: Line 721:
 
{|
 
{|
 
|style="padding: 10px 0px 15px 15px;"|Show a popup window with a notification you customize. This can be used to alert users or display important messages in a visually engaging way.
 
|style="padding: 10px 0px 15px 15px;"|Show a popup window with a notification you customize. This can be used to alert users or display important messages in a visually engaging way.
 +
 +
'''General sections:'''
 
* '''Action Name''' - name the action, this will help identify it when creating a trigger later.
 
* '''Action Name''' - name the action, this will help identify it when creating a trigger later.
 +
* '''Action Access Mode''' - Select which clients can trigger the action:
 +
** '''Disabled - No restrictions; the action will run for all clients.
 +
** '''Blacklist''' - The action will be blocked for clients in the selected customer group; all others are allowed.
 +
** '''Whitelist''' - Only clients in the selected customer group are allowed to trigger the action; all others are blocked.
 +
*'''[[#Customer_Groups|Customer Groups]]''' - Choose which client groups to include or exclude when the action runs, depending on the selected Action Access Mode.
 +
 +
'''Dedicated sections:'''
 
* '''Popup Size''' - select the size of the popup.
 
* '''Popup Size''' - select the size of the popup.
 
* '''Show Close Button''' - if enabled, the popup will include the close button.
 
* '''Show Close Button''' - if enabled, the popup will include the close button.
Line 824: Line 874:
 
|style="padding: 0px 0px 15px 15px;"|Manage 'Customer Groups' at any time,  modify the list of included clients (1), rename them (2), or delete the entire group (3).  <br/>
 
|style="padding: 0px 0px 15px 15px;"|Manage 'Customer Groups' at any time,  modify the list of included clients (1), rename them (2), or delete the entire group (3).  <br/>
  
−
'''''Important:''' Before deleting a group, make sure '''it is not assigned to any actions''''.<br/> Removing a group that is still in use may result in '''errors being logged''' when the associated action is triggered.''  
+
'''''Important:''' Before deleting a group, make sure '''it is not assigned to any action'''.<br/> Removing a group that is still in use may result in '''errors being logged''' when the associated action is triggered.''  
 
|}
 
|}
 
{|
 
{|

Latest revision as of 11:36, 13 August 2025

Contents

[edit] About Marketing Triggers Automation For WHMCS

Marketing Triggers Automation For WHMCS is a tool that automates tasks by triggering specific actions based on customer behavior or initiated processes.

Configure triggers for various events to automatically perform actions such as sending email or ticket notifications, displaying custom popups, or creating admin to-do items.
Use the module to eliminate repetitive tasks and maximize your marketing potential.

  • Addon Module Features:
✔ Create Triggers To Launch Specific Automated Actions:
✔ For Customers
✔ For Administrators
✔ View Dashboard With Recently Triggered Actions And Summary
✔ Create And Manage Actions:
✔ Specify Action Name
✔ Define For Which Clients Action Is Performed:
✔ Run For All Customers
✔ Blacklist - Exclude Clients From Selected Customer Groups
✔ Whitelist - Run For Clients In Selected Customer Groups
✔ Select Action Template:
✔ Configure Specific Settings Per Selected Action
✔ Use Available Merge Fields Variables For Selected Action
✔ Create Triggers:
✔ Add Trigger Name
✔ Set Trigger Status
✔ Select Trigger On Specific Action:
✔ Configure Related Trigger Settings
✔ Select Action To Lunch Based On Trigger
✔ Enable Overwriting Pending Action
✔ Set Action Delay In:
✔ Seconds
✔ Minutes
✔ Hours
✔ Days
✔ Create Customer Groups With Assigned Clients
✔ View Queue Of Scheduled Tasks
✔ Customize Module Language Files With "Translations" Tool
✔ View And Manage Module Logs
  • Available Actions:
✔ Add To-Do Item:
✔ Specify Title / Description / Due Date Delay (Days)
✔ Select Admin Assignment
✔ Select Initial Status
✔ Use Available Merge Fields Variables
✔ Open Support Ticket:
✔ Select Department / Assigned Admin / Ticket Template
✔ Define Subject
✔ Select Priority
✔ Select Ticket Creator
✔ Define Custom Ticket Content
✔ Use Available Merge Fields Variables
✔ Email Notification To Admin:
✔ Specify Action Name
✔ Select Email Recipients
✔ Select Email Template
✔ Email Notification To Customer:
✔ Specify Action Name
✔ Select Email Template
✔ Mark As Marketing Email
✔ Send SMS Notification To Admin - SMS Center For WHMCS Module Required:
✔ Specify Action Name
✔ Select Notified Admins
✔ Select Message Type
✔ Define SMS Custom Message
✔ Enable Instant Delivery
✔ Select API Execution Admin
✔ Mark As Marketing SMS
✔ Use Available Merge Fields Variables
✔ Send SMS Notification To Customer - SMS Center For WHMCS Module Required:
✔ Specify Action Name
✔ Select Message Type
✔ Define SMS Custom Message
✔ Enable Instant Delivery
✔ Select API Execution Admin
✔ Use Available Merge Fields Variables
✔ Show Client Area Popup:
✔ Specify Action Name / Popup Title
✔ Select Popup Size
✔ Select Popup Title
✔ Toggle Showing Close Button
✔ Define Popup Message
✔ Use Available Merge Fields Variables
  • Available Triggers:
✔ Add / Edit Credit Card
✔ Addon:
✔ Activated / Canceled / Renewed / Suspended / Unsuspended / Terminated
✔ Added To Service
✔ Removed From Service
✔ Affiliate Activated / Link Clicked / Withdrawal Requested
✔ Cancelation Requested
✔ Client:
✔ Contact Added / Edited / Deleted
✔ Details Updated
✔ Email Verified
✔ Knowledgebase Page Viewed
✔ Password Changed
✔ Quote Accepted
✔ Status Changed
✔ Service Details Viewed
✔ Domain:
✔ Contact Details Updated
✔ DNS Records Updated
✔ Details Viewed
✔ EPP Code Requested
✔ Nameservers Updated
✔ Registered / Renewed / Transferred
✔ Transfer Failed
✔ Invoice:
✔ Canceled / Unpaid / Refunded / Paid
✔ Gateway Changed
✔ Order:
✔ Placed / Canceled / Accepted
✔ Marked As Fraudulent
✔ Page Viewed
✔ Quota Status Changed
✔ Service:
✔ Created / Suspended / Unsuspended / Terminated / Renewed / Upgraded
✔ Package Changed
✔ Password Changed
✔ Ticket:
✔ Opened By Admin
✔ Opened By Client
✔ Reply By Admin
✔ Reply By Client
✔ Closed
✔ URL Post Data Contains Parameters
✔ Upgrade Page Viewed
  • Available Merge Fields Variables:
✔ Addon Activated / Addon Canceled / Addon Renewed / Addon Suspended / Addon Terminated / Addon Unsuspended
✔ Addon Added to Service
✔ Addon Removed From Service
✔ Affiliate Activated / Affiliate Link Clicked / Affiliate Withdrawal Requested
✔ Service Password Changed / Service Package Changed / Service Renewed / Service Suspended / Service Terminated / Service Unsuspended
✔ Cancelation Requested / Client Service Details Viewed
✔ Client - Quote Accepted
✔ Client - Password Changed / Client - Knowledgebase Page Viewed / Client - Email Verified
✔ Client - Details Updated / Client - Status Changed / Add / Edit Credit Card / Client - Contact Deleted / Page Viewed / URL Post Data Contains Parameters
✔ Client - Contact Added / Client - Contact Edited
✔ Domain Details Viewed / Domain Contact Details Updated / Domain DNS Records Updated / Domain Nameservers Updated
✔ Domain EPP Code Requested / Domain Registered / Domain Renewed / Domain Transferred
✔ Domain Transfer Failed
✔ Invoice Canceled / Invoice Paid / Invoice Refunded / Invoice Unpaid / Order Accepted / Order Canceled
✔ Invoice Gateway Changed / Order Marked as Fraudulent
✔ Order Placed
✔ Quota Status Changed
✔ Service Created
✔ Ticket Reply by Admin / Ticket Closed / Ticket Opened by Admin
✔ Ticket Opened by Client / Ticket Reply by Client
✔ Upgrade Page Viewed
  • General Info:
✔ Supports WHMCS Opt-In/Out Marketing Email Settings
✔ Integrated With SMS Center For WHMCS - Send SMS Notifications To Admins And Customers
✔ Multi-Language Support With Custom Translations Tool
✔ Supports Google Analytics 4
✔ Supports PHP 8.3 Back To PHP 8.1
✔ Supports WHMCS V8.13 Back To WHMCS V8.10
✔ Requires ionCube Loader V14 Or Later
✔ Easy Module Upgrade To Open Source Version

[edit] Installation

This tutorial will show you how to successfully install and configure Marketing Triggers Automation For WHMCS.

We will guide you step by step through the whole installation and configuration process.

1. Log in to our client area and download the module.
MTA 1.png
2. Extract the package and upload its content into the main WHMCS directory.

The content of the package to upload should look like this.

MTA 2.png
3. When you install Marketing Triggers Automation For WHMCS for the first time you have to rename 'license_RENAME.php' file.

The file is located in 'modules/addons/MarketingTriggersAutomation/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

MTA 3.png
4. In order to configure your license key, you have to edit the previously renamed 'license.php' file.

Enter your license key between quotation marks as presented on the following screen. You can find your license key in our client area → 'My Products'.

MTA 4.png
5. Now you have to activate the module in your WHMCS system.

Log in to your WHMCS admin area. Go to 'System Settings' → 'Addon Modules'. Afterwards, find 'Marketing Triggers Automation' and press the 'Activate' button.

MTA 6.png
6. In the next step, you need to permit access to this module.

To do so, click on the 'Configure' button, tick 'Full Administrator' and press 'Save Changes'.

MTA 7.png
7. The final step of the module installation is setting up a cron command that is required for several module features to work properly. 
 php -q /yourWHMCS/modules/addons/MarketingTriggersAutomation/cron/cron.php actions:run

Note that the above directory is exemplary, please adjust the cron line to your own needs. 5 minute interval is recommended.

8. You have just successfully installed Marketing Triggers Automation!

You can access your module under 'Addons' → 'Marketing Triggers Automation'.

MTA 8.png

[edit] Management

Marketing Triggers Automation For WHMCS lets you automate tasks based on customer actions and triggered in your WHMCS processes.

In this guide, we will walk you through the management features of the module.

[edit] Dashboard

The dashboard provides crucial information regarding the module operating processes.

At the top, you will find the 'Configuration Guide' make sure to read it thoroughly to learn how to set up actions and triggers.
This documentation will cover the same topics in detail as well.

MTA 9.png
Besides the guide, the dashboard features 'Recently Triggered Actions' table which presents the history of actions including:
  • ID - the event ID number.
  • Triggered by - the username of the client or administrator that triggered the action.
  • Trigger - which of the triggers launched the action.
  • Action - which of the actions was triggered.
  • Status - the event status: "Pending", "Finished", "Error" and "Ready".
    Note: The "Ready" status indicates that an action is prepared and waiting for the customer.
MTA 10.png
The 'Actions Summary' counts actions taken by the module, the counters include:
  • Actions Triggered in the Last 24 Hours
  • Actions Triggered in the Last 7 Days
  • Actions Triggered in the Last 30 Days
  • Total Actions Triggered
MTA 11.png

[edit] Actions

After the module detects a trigger, the actions associated with that trigger will be automatically launched. To customize the module and compose a list of actions you wish to be launched automatically, navigate to the 'Actions' section of the addon.

To create the first action, click on the 'Create Action' button.

MTA 12.png
Choose the name of the single action for easy identification, it will be selected when adding triggers in the next steps, and then select the action from the list.
MTA 12 1.png
In this way, add to the list all the actions you wish to be automated and performed after certain system events.
Further, you will find descriptions of all possible actions and their specifications to be configured per your need.

To configure the action click on the 'Edit' button.

MTA 14.png

[edit] Add To-Do Item

This action will create an item in the WHMCS to-do list. Use it to assign and track specific tasks related to triggers within your workflow.

Complete the following fields and click 'Submit' to create the action.
If you want, you can use merge fields, they can be found below the action form. Find the trigger you plan to use to see merge fields available for it.

  • Action Name - name the action, this will help identify it when creating a trigger later.
  • Action Access Mode - Select which clients can trigger the action:
    • Disabled - No restrictions; the action will run for all clients.
    • Blacklist - The action will be blocked for clients in the selected customer group; all others are allowed.
    • Whitelist - Only clients in the selected customer group are allowed to trigger the action; all others are blocked.
  • Customer Groups - Choose which client groups to include or exclude when the action runs, depending on the selected Action Access Mode.
  • Title - enter a title, it will be used to name the to-do item.
  • Description - provide a description for the to-do item.
  • Due Date Delay (Days) - enter how many days after the trigger the action should be taken.
  • Admin Assignment - select which admin will be assigned to the to-do item.
  • Initial Status - select the status of the to-do item with which it should be created.
MTA 15.png

[edit] Send Email Notification to Admin

Send an email to selected admins. This can be used to notify specific team members about important updates or actions that require their attention.
  • Action Name - Name the action, this will help identify it when creating a trigger later.
  • Action Access Mode - Select which clients can trigger the action:
    • Disabled - No restrictions; the action will run for all clients.
    • Blacklist - The action will be blocked for clients in the selected customer group; all others are allowed.
    • Whitelist - Only clients in the selected customer group are allowed to trigger the action; all others are blocked.
  • Customer Groups - Choose which client groups to include or exclude when the action runs, depending on the selected Action Access Mode.
  • Email Recipient - Select which admins will receive the email, the Triggering Admin, is the admin that is responsible for triggering the event.
  • Email Template - Select the email template that will be used for the action.
MTA 16.png

[edit] Send Email Notification to Customer

Send an email to clients when they trigger the action. This is useful for keeping clients informed or confirming actions they have initiated.

General sections:

  • Action Name - name the action, this will help identify it when creating a trigger later.
  • Action Access Mode - Select which clients can trigger the action:
    • Disabled - No restrictions; the action will run for all clients.
    • Blacklist - The action will be blocked for clients in the selected customer group; all others are allowed.
    • Whitelist - Only clients in the selected customer group are allowed to trigger the action; all others are blocked.
  • Customer Groups - Choose which client groups to include or exclude when the action runs, depending on the selected Action Access Mode.

Dedicated sections:

  • Email Template - select the email template that will be used for the action.
  • Mark as Marketing Email - If enabled, this email notification will be classified as a marketing message, and customers who have opted out of marketing emails will not receive it.
    If the option is disabled, the email will be sent regardless of the customer's marketing preferences.
    Note: If WHMCS has the "Marketing Emails" feature completely disabled in its settings, all notifications will be delivered regardless of the switch status.
MTA 17.png

[edit] Open Support Ticket

This action will create an open support ticket for the customer that triggers it.
It helps automate the process of addressing customer issues by automatically generating a ticket for prompt follow-up.

General sections:

  • Action Name - name the action, this will help identify it when creating a trigger later.
  • Action Access Mode - Select which clients can trigger the action:
    • Disabled - No restrictions; the action will run for all clients.
    • Blacklist - The action will be blocked for clients in the selected customer group; all others are allowed.
    • Whitelist - Only clients in the selected customer group are allowed to trigger the action; all others are blocked.
  • Customer Groups - Choose which client groups to include or exclude when the action runs, depending on the selected Action Access Mode.


Dedicated sections:

  • Department - select the department to assign the ticket to.
  • Assigned Admin - select the admin that will be assigned to the ticket.
  • Ticket Templates - select a ticket template for its contents, or pick 'Custom' to create a new one.
    Note: Ticket templates can be found in WHMCS under 'System Settings' → 'Email Templates' → 'Support Messages'.
  • Subject - enter a subject for the ticket, you can use merge fields here. The full list of merge fields can be found at the bottom of the page.
  • Priority - select the priority level of the ticket.
  • Ticket Creator - select who should be the creator of the ticket.
  • Custom Ticket Content - if you decide to create your custom ticket template, an editor will be displayed where you can write its contents including merge fields, HTML tags and CSS styles.
MTA 18.png

[edit] Send SMS Notification to Admin

Important: This action requires the SMS Center For WHMCS module to be installed and active.
Send an SMS message to selected admins. This can be used to notify admins about important updates or actions that require their attention via SMS.


General sections:

  • Action Name - name the action, this will help identify it when creating a trigger later.
  • Action Access Mode - Select which clients can trigger the action:
    • Disabled - No restrictions; the action will run for all clients.
    • Blacklist - The action will be blocked for clients in the selected customer group; all others are allowed.
    • Whitelist - Only clients in the selected customer group are allowed to trigger the action; all others are blocked.
  • Customer Groups - Choose which client groups to include or exclude when the action runs, depending on the selected Action Access Mode.

Dedicated sections:

  • API Execution Admin - select which admin will be used to execute the API.
  • Notified Admins - select which admins will receive the message. 'Triggering Admin' is the admin that has triggered the action.
  • Instant Delivery - enable to skip the SMS Center For WHMCS queue and send the message immediately.
  • Message Type - select a message type from SMS Center For WHMCS or create a 'Custom Message'.
  • SMS Custom Message - if 'Custom Message' is selected this field will appear. You can enter the message text including merge fields found under it.
MTA 19.png

[edit] Send SMS Notification to Customer

Important: This action requires the SMS Center For WHMCS module to be installed and active.
Send an SMS message to the triggering client. This allows you to quickly notify the client via SMS about important updates or actions they have initiated.

General sections:

  • Action Name - give the action a name to help you identify it when setting up a trigger later.
  • Action Access Mode - Select which clients can trigger the action:
    • Disabled - No restrictions; the action will run for all clients.
    • Blacklist - The action will be blocked for clients in the selected customer group; all others are allowed.
    • Whitelist - Only clients in the selected customer group are allowed to trigger the action; all others are blocked.
  • Customer Groups - Choose which client groups to include or exclude when the action runs, depending on the selected Action Access Mode.

Dedicated sections:

  • API Execution Admin - choose the admin who will execute the API for this action.
  • Mark as Marketing SMS - If enabled, this SMS will be classified as a marketing message:
    • "Marketing SMS" checkbox in the client profile is disabled - Customers will not receive the SMS.
    • "Marketing SMS" checkbox in the client profile is enabled - Customers will receive the SMS.
    • If Mark as Marketing SMS in the addon is disabled, clients will receive messages regardless of their marketing preferences.
  • Instant Delivery - turn this on to bypass the SMS Center For WHMCS queue and send the message right away.
  • Message Type - pick a message type from SMS Center For WHMCS or create your own 'Custom Message'.
  • SMS Custom Message - If you select 'Custom Message', this field will appear, allowing you to enter the message content, including any applicable merge fields.
MTA 20.png

[edit] Show Client Area Popup

Show a popup window with a notification you customize. This can be used to alert users or display important messages in a visually engaging way.

General sections:

  • Action Name - name the action, this will help identify it when creating a trigger later.
  • Action Access Mode - Select which clients can trigger the action:
    • Disabled - No restrictions; the action will run for all clients.
    • Blacklist - The action will be blocked for clients in the selected customer group; all others are allowed.
    • Whitelist - Only clients in the selected customer group are allowed to trigger the action; all others are blocked.
  • Customer Groups - Choose which client groups to include or exclude when the action runs, depending on the selected Action Access Mode.

Dedicated sections:

  • Popup Size - select the size of the popup.
  • Show Close Button - if enabled, the popup will include the close button.
  • Popup Title - include the title of the popup.
  • Popup Template - select a template for the popup or pick 'Custom' to create a new one.
    Note: You can include templates by adding a new .tpl file under 'modules/addons/MarketingTriggersAutomation/resources/popupTemplates'.
  • Popup Message - if 'Custom' popup template is selected, you can create your message here, including merge fields, HTML, JS and CSS code.
MTA 21.png
This is how the notification is displayed to the user.
MTA 22.png
Once all the actions have been configured, you can manage them further by editing or deleting individual actions.

Alternatively, you can use the mass action function to delete multiple actions at once.

MTA 13.png

[edit] Triggers

Once the set of actions you wish to be automatically launched is ready, you can proceed and set up triggers that will cause these actions to be activated.

Move to the 'Triggers' section now and click on 'Create Trigger'.

MTA 23.png
While creating a trigger, you will need to specify:
  • Name - name the trigger.
  • Status - enable or disable the trigger, you can always change the status later.
  • Trigger - select the trigger for the action. Depending on the selected trigger, various sub-options may appear at this point.
    For example, as shown below, when using the Service Suspended trigger, the Enabled on Products option will appear, allowing you to select individual products.
    For the Order Accepted trigger, the options Assigned Admins and Auto-Accepted Orders will appear (the action will be triggered when the order is automatically accepted by WHMCS).
  • Action - select the action to be taken when the trigger occurs.
  • Overwrite Pending Action - enable to ensure only the latest data update occurs.
  • Action Delay Unit - select the unit for action delay (seconds, minutes, hours, days).
  • Action Delay Value - enter the value for action delay.
  • Additional Trigger-specific Fields - some triggers might include additional configuration fields.
MTA 24.png
List of triggers available to activate:
Trigger Trigger Trigger
Add/Edit Credit Card Addon Activated Addon Added to Service
Addon Cancelled Addon Removed Addon Renewed
Addon Suspended Addon Terminated Addon Unsuspended
Affiliate Activated Affiliate Link Clicked Affiliate Withdrawal Requested
Cancellation Requested Service Upgraded Order Cancelled
Order Marked as Fraudulent Client - Contact Added Client - Contact Deleted
Client - Contact Edited Client - Details Updated Client - Email Verified
Client - Knowledgebase Page Viewed Client - Password Changed Client - Quote Accepted
Client - Status Changed Domain Contact Details Updated Domain DNS Records Updated
Domain Details Viewed Domain EPP Code Requested Domain Nameservers Updated
Domain Registered Domain Renewed Domain Transfer Failed
Domain Transferred Invoice Refunded Invoice Unpaid
Invoice Cancelled Invoice Gateway Changed Invoice Paid
Order Accepted Order Placed Upgrade Page Viewed
Page Viewed Quota Status Changed Service Created
Service Details Viewed Service Package Changed Service Password Changed
Service Renewed Service Suspended Service Terminated
Service Unsuspended Service Upgraded URL Post Data Contains Parameters
Ticket Reply by Client Ticket Closed Ticket Opened by Admin
Ticket Opened by Client Ticket Reply by Admin
After a trigger is added, you can disable/enable it with the 'Status' toggle, as well as edit or delete it with the action buttons.
MTA 25.png
You can also use the mass function to delete multiple triggers at once.
MTA 26.png

[edit] Customer Groups

Customer Groups let you define which clients should be included or excluded from a specific action, based on the selected Action Access Mode.
This allows you to precisely control your target audience for each marketing trigger.

Note: Customer Groups in this module are not the same as WHMCS Client Groups. They are managed entirely within the module and exist independently.

Start by creating the needed groups. Go to the Customer Groups section and click Create Group.

MTA 26 1.png
In the form enter a name for the group.
MTA 26 2.png
Once created, you will be redirected to the group view where you can start adding individual clients.
MTA 26 3.png
MTA 26 4.png
You can manage the list of clients in the group at any time, add or remove members as needed.
MTA 26 5.png
Manage 'Customer Groups' at any time, modify the list of included clients (1), rename them (2), or delete the entire group (3).

Important: Before deleting a group, make sure it is not assigned to any action.
Removing a group that is still in use may result in errors being logged when the associated action is triggered.

MTA 26 6.png
Usage Example

When configuring an action, you will see two related fields:

  • Action Access Mode - A setting that defines how the selected groups should be interpreted.
    • Disabled - No restrictions. The action applies to all clients, regardless of group.
    • Blacklist - Clients in the selected customer group will be excluded from the action. All others are included.
    • Whitelist - Only clients in the selected customer group will be included. All others are excluded.
      If you select Blacklist or Whitelist, at least one Customer Group must be selected. Otherwise, the action cannot be saved.
  • Customer Groups – A multi-select field where you choose one or more preconfigured groups.

To illustrate the usage, blacklist the Internal Clients group to avoid showing live promotions to internal users.

MTA 26 7.png

[edit] Queue

The "Queue" tool helps you track and manage the tasks created by the module.

It allows you to view and interact with task details, including task IDs, statuses, and related items.
You can filter tasks, execute actions like deleting or running tasks, and even use mass actions for bulk operations.
For detailed guidance on using this tool, please refer to the dedicated article available here.

MTA 28 0.png

[edit] Translations

Customizing language files is now extremely easy with the "Translations" tool that is now available directly in the addon.
Its user-friendly design makes managing various language file tweaks a smooth and efficient process. Prepare translations for the original English files with this handy built-in tool.

For specific instructions on how to use this tool please refer to its dedicated article, you will find it here.

MTA 27.png

[edit] Logs

The "Logs" tool makes monitoring and managing module activity records simple and efficient. It provides options to categorize, filter, and view detailed entries, giving you control over the logs.
Features like bulk deletion, rule-based deletion, and export options make it easy to organize and maintain your logs.

For detailed guidance on using this tool, check its dedicated article, which is available here.

MTA 28.png

[edit] Tips

1.You can combine various triggers and actions into almost countless combinations.
The examples provided in the documentation are just a few of the possible configurations.

[edit] Update Instructions

An essential guidance through the process of updating the module is offered here.

Ensure successful completion of the module update by carefully following each step, thereby preventing data loss or any unforeseen issues.
Additionally, you will find a current list of supplementary actions necessary for a smooth update process there.

[edit] Migration Guide

While upgrading to version 1.2.0 make sure to follow those guidelines:

1. Follow the update guide located here.
2. Delete all files from the previous version of the module.
3. Upload the new module files.
4. Migration tool should run automatically and transfer all your existing data; however, if that is not the case, please manually initiate the version upgrade with the cron command: 

php -q /YOUR_WHMCS/modules/addons/MarketingTriggersAutomation/cron/cron.php upgrade run 1.2.0

The above migration tool will transfer your existing data and saved configuration.

[edit] Upgrade Guide

Seeking a solution that offers greater flexibility, customization tailored to your precise needs, and unrestricted availability?
There is an option that not only proves to be cost-effective in the long run but also includes prioritized support services, making it a truly valuable investment.

Opt for the Open Source version of your Marketing Triggers Automation For WHMCS module to unlock these benefits.
Simply click on either the Get Source Code or Upgrade To Lifetime button found on the product's page in our client area to complete the one-step upgrade process, with a dedicated discount already applied.

Follow a comprehensive guide covering the transition process, the advantages it brings, and step-by-step instructions on what to do next after the order has been successfully finalized.

[edit] Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=Marketing_Triggers_Automation_For_WHMCS&oldid=77215"
Navigation
WHMCS Modules
WHMCS Widgets
Tools And Applications
Translations
General
FAQ
Community
Marketing Triggers Automation For WHMCS