2019-4Q: Send Emails on Trigger

A new feature has been added to enhance the Emails functionality. It allows for an operator to send a fully flexible emails on any trigger we have implemented in SIMPLer. In another words an email with any Subject/Message can be send following

•  Customer Details Change

•  Customer Status Change

•  Customer Auto-Payment Change

•  Product Change

•  Equipment Change

•  Credit Card Change

•  EFT Change

•  Invoice Change

•  Trigger on Bucket Change

•  Subscription Change

•  Customer Subscription

•  Customer SAND Notification

•  RADIUS Username Change

•  RADIUS Send Coa / Pod

•  Customer Equipment Synchronize

•  Credit Card Failed Payment Counter Change

•  EFT Failed Payment Counter Change

•  Email Account Change

•  Customer CPE Change

• and more as this list will get bigger as we add triggers in

Triggered based interface for remote APIs is documented under below link:

http://wiki.azotel.com/2015-1q-triggered-based-interface-for-remote-apis

To make use of this feature:

    1. Navigate to Triggers page

    2. Add 'Email on Trigger' 

Fig 2. Setting up Email on trigger

  Following are fields:

• • Triggers - defines for what triggers email should be sent (i.e. screenshot example will send emails on customer status changes)

  • Condition - allows defining an additional condition that can be used to send email on some pre-set condition (i.e. screenshot example will send emails on customer status change to 'waiting for provision')

  • Email_To - address email will be sent to

  • Email_Cc - address email a copy of email will be sent to

  • Email_Bcc - address email a silent copy of email will be sent to

  • Email_Subject - email subject - it's format is flexible and allows use of variables (i.e. %%customerid%% will be replaced with respective customer CustomerID as defined in SIMPLer)

  • Email_Message - email body - it's format is flexible and allows use of variables. If the Message is left blank it will send an email listing ALL available variables for a particular trigger

Useful Conditions:

$param{status} eq 'Web Request' && $param{TriggerType} eq 'customer_status_change' && $param{action} ne 'new'

or

$param{status} eq 'Web Request' && $param{TriggerType} eq 'customer_status_change' && $param{action} eq 'update'

or

$param{status} eq 'Waiting for Install' && $param{TriggerType} eq 'customer_status_change' && $param{custom_field_12} eq 'Y'

(The above condition will send the email only if the customer_status_change is triggered and status is Web Request, the action ne new prevents the trigger to be sent when a new customer is added as status change is triggered for new customers, this can be useful when adding customers and then modifying the status straight after)

Sending the email to the customer:

If you want to send the email to the customer's email address, you can add in the variable %%EMAIL%% to the email_to field, this will send the email to the customer where the trigger was fired from. Note: it is also good to add your own email as bcc just to test everything is working correctly.

Email Templates:

It is also possible to define an email template in SPID settings, just make sure to insert the same name in the trigger as what you defined the template to be in the SPID settings, the email subject should be set in the trigger settings.

Available Parameters for the Conditions:

Below is a list of available parameters that can be used as $param{name of param} in the Condition field of the trigger (see above for some example conditions)

$param{customerid}

$param{name}

$param{nickname}

$param{status}

$param{status_reason}

$param{status_date}

$param{status_assigned}

$param{status_notes}

$param{isDeliquent}

$param{customertype}

$param{first_time_current}

$param{action}

$param{custom_field_*} (note: replace * with the custom field id)

Useful link to WiKi:

http://wiki.azotel.com/2015-1q-triggered-based-interface-for-remote-apis

Published Date: 28/Oct/2019

Change History Log:

28/Oct/2019 Maciej

19/Feb/2020 HLombard

21/Aug/2024 Anthony

Contact Azotel Support:

Need more help? Save time by creating a maintenance ticket to Azotel through your instance.