4. Managing Notifications

Automated notifications are essential for communicating with your clients to update them on any developments with their accounts, subscriptions or orders. This page contains information on how to configure your email settings to send notifications, as well as how to customize notification content and style.

Email Settings

The details specified here will be used to send email notifications to your customers.

Please note that as of release 3.28.54 the only way to send notifications will be to configure the settings in this section.

Select the Mail Server Authorization Type and enter your account and server details.

All fields are required in this section.

Default SMTP

  • Mail Account Name - The name of your email account (e.g., Jane Doe)

  • Mail Account Address - The email address of the account (e.g., jdoe@mymail.com)

  • Mail Server - The SMTP server address (e.g., smtp.mymail.com)

  • Encryption - The type of encryption the email server supports (SSL or TLS)

  • Email Port - The port used by the email server

  • Mail Password - The email account password

Select Save to apply the specified settings.

Send Test Mail

Additionally, send a test email notification to verify the information by selecting Send Test Mail. The email is sent to the address of the account you are logged in with, and its contents are the following:

  • Subject: Test Email

  • Body: This is the test email you requested.

Please note that the Send Test Email button does not apply or save the settings for any of the Authorization Types.

Gmail OAuth v2.0

 

  • Mail Account Name - The name of your email account (e.g., Jane Doe)

  • Mail Account Address - The email address of the account (e.g., jdoe@gmail.com)

  • Client ID - The client ID is an alphanumerical string obtained from Google used to give consent to the app to access the user’s data

  • Client Secret - A secret key obtained from Google for authenticating third party applications

 

 

When the fields above have been specified, select Save and then Authenticate.

After a successful authentication, the fields will be locked. To edit them again, select Revoke.

In case of a failed authentication, after making the necessary corrections, select Save and then Authenticate again.

The Send Test Mail function is described in this section: https://interworkscloud.atlassian.net/wiki/spaces/ICPD/pages/452723619/4.+Managing+Notifications#Send-Test-Mail

Office 365 OAuth v2.0

 

  • Mail Account Name - The name of your email account (e.g., Jane Doe)

  • Mail Account Address - The email address of the account (e.g., jdoe@gmail.com)

  • Client ID - The client ID is an alphanumerical string obtained from Microsoft used to give consent to the app to access the user’s data

  • Secret Key - A secret key obtained from Microsoft for authenticating third party applications

  • Tenant ID - The tenant ID is a globally unique organization identifier

Select Save to apply the specified settings.

The Send Test Mail function is described in this section: https://interworkscloud.atlassian.net/wiki/spaces/ICPD/pages/452723619/4.+Managing+Notifications#Send-Test-Mail

Email Template

Users can apply their own style and format to their email notifications. Until now, the notifications sent to the end customers were the ones set in the BSS which had the distributor’s branding. As long as Resellers own their own storefront, the notifications can be customized according to their needs.

Select the Photograph Icon to add an image to the header.

Select the T Icon to format the footer text.

 

For the Header and Footer style, you may select the respective Paint Bucket Icon to change the background color. Select the color, and the Droplet Icon to make the background transparent.

The Header and Footer setting will be applied to all Reseller available Notifications which are displayed on the Notifications page.

Neither the header or footer are required. If the reseller does not want to set a header or a footer for their notification, the header section on the Notification template preview will be used. When the notification is sent, no header or footer section will be displayed.

Save your choices by selecting Save.

Notifications List

Go to Settings, then Notifications and select the Notifications tab. There are two groups of notifications: Customers and Orders.

 

Select a group to expand it and view the available notifications. Each notification allows you to enable or disable it.

Select the Pencil Icon to go to the Notification Details page and edit the content of the notification.

The following table shows the default notifications and their default content:

Notification Group

Notification Name

Description

Customers

Successful customer activation

Sent when a customer is successfully activated.

Customers

Successful Storefront user password reset 

Sent when a Storefront user successfully resets their password.

Customers

Customer activation link 

Sends an activation link when a customer is created.

Customers

Request for Storefront user password reset

Sent when a user selects “Forgot password” on Storefront login page or when you select the “Reset Storefront Password” action. 

Customers

Self-registration request rejection

Sent when a customer's self-registration request has been rejected.

Customers

Request for Storefront user registration 

Sent when a Storefront user registers at the Storefront.

Customers

Storefront user 2FA verification code

Sent when a Storefront user attempts to log in with 2FA enabled

Orders

Customer order confirmation

Sent when a customer checks out their basket.

Orders

Order not executed due to reseller insufficient credit

Sent to the reseller when the end customer checks out their basket while the former has no available credit.

Notification Details

On this page, the Reseller of the Standard Edition can edit:

  • The notification recipients

  • The notification body

As well as preview the notification with the selected template.

Enable or disable the notification by changing the state of the toggle in the top right of the page. Please note that if you change the state of the toggle here, you must Save to apply it.

The page contains the fields To, Subject and Body with their default values, which can be edited manually. Select Cc and Bcc to add those fields as well.

Select Insert Parameter to insert a parameter to any of the fields above. Available parameters differ based on the notification group. Use the search bar to quickly find any required parameters.

 

Select Revert to Default to restore the default content of the field.

To customize the template of the email, select Set email template.

The bottom part of the page shows a Preview of what the email will look like with the template applied.

Select Save to apply your changes to the notification.

Available Parameters

The following parameters will be available for the Customers notifications.

  • Customers Notifications

    • Activate account link, [#ActivationUrl#] - A link that redirects the user to the activate account page, where the user can set their password. Resellers should not use the link from these notifications because they can set Storefront credentials on behalf of their customers.

    • Customer’s name, {#Accounts.AccountName#} - Merge field of the end customer name

    • Reset password link, [#ResetPasswordUrl#] - A link that redirects the user to the reset password page, where the user can reset their password. Resellers should not use the link from these notifications because they can set Storefront credentials on behalf of their customers.

    • Storefront user email, {#Contacts.Email#} - Merge field

    • Storefront URL, [#StorefrontUrl#] - A link with the Standard Reseller’s storefront URL

    • Storefront user’s full name, {#Contacts.FullName#} - A text field which will include the storefront user’s Customer Name

    • Customer view link, [#CustomerView#] - Redirects the user to <strURL/customer-view/idcustomer>

Orders Notifications

The following parameters will be available for the Orders notifications.

  • Customers

    • Customer’s name, {#Accounts.AccountName#}

    • Storefront URL, [#StorefrontUrl#]

  • Orders

    • Creator’s email, {#Orders.CreatorEmail#} - The email of the Storefront user who created the order

    • Order’s URL, [#OrderStrfUrl#] - A URL with the corresponding order ID. On click, the end customer will be redirected to the Storefront order view page. If they are a logged out, they will initially be redirected to the login page to set their credentials. If the reseller selects to receive this notification, then they will be redirected to the order view page on the admin menu.