Notifications - Revision history

SarahK at 18:30, 16 June 2022

2022-06-16T18:30:25Z

SarahK: /* Configuring Email Notifications */

2022-05-30T16:56:31Z

‎Configuring Email Notifications

SarahK: /* Hooks */

2022-05-30T16:56:17Z

‎Hooks

SarahK: /* API */

2022-04-26T20:32:23Z

‎API

SarahK: /* Hooks */

2022-04-26T20:31:46Z

‎Hooks

SarahK at 21:29, 14 April 2022

2022-04-14T21:29:42Z

SarahK at 22:13, 1 March 2022

2022-03-01T22:13:18Z

SarahK at 22:13, 1 March 2022

2022-03-01T22:13:04Z

SarahK at 18:19, 4 August 2020

2020-08-04T18:19:02Z

SarahK at 17:17, 30 April 2020

2020-04-30T17:17:41Z

Show changes

@@ Line 54: / Line 54: @@
 ==Modifying a Notification Rule==
 To edit a notification, locate the notification rule you wish to edit and click the pencil icon. This will open the rule configuration dialog box, where you can make your desired changes.
@@ Line 62: / Line 60: @@
 ==Duplicating a Notification Rule==
 To duplicate a notification, locate the notification rule you wish to copy and click the copy icon (two files). This will open the rule configuration dialog where you can customise the rule and then click the Duplicate button to complete the process.
@@ Line 70: / Line 66: @@
 ==Enabling/Disabling a Notification Rule==
 An on-or-off slider in the Notification Rules table indicates the current status of each notification rule. To toggle the status of a notification, click the slide toggle for the desired notification rule.
 ==Deleting a Notification Rule==
 To delete a notification, locate the notification rule you wish to edit and click the trash can icon.

@@ Line 92: / Line 92: @@
 # Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Notifications]]''' or, prior to WHMCS 8.0, '''Setup > Notifications'''.
-# Click '''Configure''' for '''Email'''.[[File:Email-notification-configuration.JPG]]
+# Click '''Configure''' for '''Email'''.<br/>[[File:Email-notification-configuration.JPG]]
 # Configure the Email module settings:
 #* '''Sender Name''' — The name you wish for emails from this module to be sent as, typically something unique that stands out to prevent these notifications from being missed.

← Older revision		Revision as of 16:56, 30 May 2022
Line 84:		Line 84:

	The system can't restore a rule after it deletes it. If you may want to reuse the rule in future, we recommend disabling the rule instead of deleting it.		The system can't restore a rule after it deletes it. If you may want to reuse the rule in future, we recommend disabling the rule instead of deleting it.
		+
		+	==Configuring Email Notifications==
		+
		+	Email notifications you to receive notifications to your email address when events occur within WHMCS.
		+
		+	To configure this:
		+
		+	# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Notifications]]''' or, prior to WHMCS 8.0, '''Setup > Notifications'''.
		+	# Click '''Configure''' for '''Email'''.[[File:Email-notification-configuration.JPG]]
		+	# Configure the Email module settings:
		+	#* '''Sender Name''' — The name you wish for emails from this module to be sent as, typically something unique that stands out to prevent these notifications from being missed.
		+	#* '''Sender Email''' — The email address the notification should come from.
		+	# Click '''Save Changes'''.
		+
		+	<div class="docs-alert-info">
		+	This module is not encoded. You can use it as a sample in developing custom notification provider modules or extend it further.
		+	</div>

	==Hooks==		==Hooks==

@@ Line 153: / Line 153: @@
 </source>
-After you create your API call, you next need to navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Notifications''' ('''Setup > Notifications''' prior to WHMCS 8.0) in the WHMCS Admin Area and define a rule for this event.
+After you create your API call, return to the WHMCS Admin Area and define a rule for this event.
 # Click "Create New Notification Rule".
 # Type a name for your Notification Rule.

@@ Line 87: / Line 87: @@
 ==Hooks==
-Using hooks, it is possible to implement more complex conditional logic than is possible with the conditions available via the Admin Area ('''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Notifications''' or, prior to WHMCS 8.0, '''Setup > Notifications''').
+Using hooks, it is possible to implement more complex conditional logic than is possible with the conditions available via the Admin Area.
 WHMCS includes a "[https://developers.whmcs.com/hooks-reference/everything-else/#notificationpresend NotificationPreSend]" hook point, which executes prior to the system sending a notification. This allows you to apply additional conditional criteria and manipulate the notification message. You can also use this hook point to abort the sending of a Notification that uses your logic.

@@ Line 1: / Line 1: @@
 WHMCS integrates with popular team communication apps, including Slack and HipChat, to allow WHMCS to notify you in real time as events occur.
-You can configure these notifications at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Notifications''' or, prior to WHMCS 8.0, '''Setup > Notifications'''.
+You can access this feature at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Notifications''' or, prior to WHMCS 8.0, '''Setup > Notifications'''.
 [[File:Notifications Home.png|900px]]

← Older revision		Revision as of 22:13, 1 March 2022
Line 1:		Line 1:
−	~~[[File:Notifications Home.png\|900px]]~~
−
	WHMCS integrates with popular team communication apps, including Slack and HipChat, to allow WHMCS to notify you in real time as events occur.		WHMCS integrates with popular team communication apps, including Slack and HipChat, to allow WHMCS to notify you in real time as events occur.

@@ Line 85: / Line 85: @@
 ==Hooks==
-Using hooks, it is possible to implement more complex conditional logic than is possible with the conditions available via the Admin Area (Setup >> Notifications).
+Using hooks, it is possible to implement more complex conditional logic than is possible with the conditions available via the Admin Area ('''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Notifications''' or, prior to WHMCS 8.0, '''Setup > Notifications''').
 WHMCS includes a "[https://developers.whmcs.com/hooks-reference/everything-else/#notificationpresend NotificationPreSend]" hook point, which executes prior to the system sending a notification. This allows you to apply additional conditional criteria and manipulate the notification message. You can also use this hook point to abort the sending of a Notification that uses your logic.
@@ Line 151: / Line 151: @@
 </source>
-After you create your API call, you next need to navigate to Setup > Notifications in the WHMCS Admin Area and define a rule for this event.
+After you create your API call, you next need to navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Notifications''' ('''Setup > Notifications''' prior to WHMCS 8.0) in the WHMCS Admin Area and define a rule for this event.
-From the WHMCS Admin Area, navigate to Setup > Notifications.
+# From the WHMCS Admin Area, navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Notifications''' ('''Setup > Notifications''' prior to WHMCS 8.0).
+# Click "Create New Notification Rule".
-Click "Create New Notification Rule".
+# Type a name for your Notification Rule.
+# Select "API" and "Custom API Trigger".
-Type a name for your Notification Rule.
+# Under "Trigger Identifier", input the notification identifier you specified in the API call. In our example, this is "adminarea.staff.login".
+# Select "Exact Match" in the select element above.
-Select "API" and "Custom API Trigger".
+# Finally, select and configure the notification method. For example, in the screenshot below, we are configuring an Email notification to login-notifications@example.net.
 [[File:NotificationsAPISetup.png]]