Difference between revisions of "Configuring Notifications with HipChat"

Revision as of 15:14, 10 September 2021

Configuring HipChat notifications allows you to receive notifications in your HipChat rooms when events occur in WHMCS.

For more information on notifications, see Notifications.

Configuring HipChat Notifications

Begin by navigating to Setup > Notifications and clicking Configure for HipChat.

Configure the HipChat module:

API Token — The WHMCS HipChat integration requires a HipChat API V2 User Token. This allows WHMCS to communicate with all of your HipChat rooms. Enter your token here. If you don't have an API token, see below.
API URL — Only required for HipChat Server users. If using HipChat Server, enter the URL to the API of your hosted instance. HipChat Cloud users should leave this field blank.

Then, click Save Changes. WHMCS will attempt to verify the API token you provided.

If verification fails, you will receive an error message. Check that the API token is entered correctly and has all the required scopes before you try again.
If verification succeeds, HipChat will become active.

Next, Create Your First Notification Rule.

Creating an API Token inside HipChat

To create a new token:

Log in to [www.hipchat.com] and go to Account Settings > API Access.
Under Create new token, enter a label for the token.
Select both the View Room and Send Notification scopes. Failure to select both of these will result in errors.

@@ Line 1: / Line 1: @@
-Configuring Notifications with HipChat allows you to receive notifications in your HipChat rooms when events occur within WHMCS.
+Configuring HipChat notifications allows you to receive notifications in your HipChat rooms when events occur in WHMCS.
-For more information on Notifications, please refer to the [[Notifications|Notifications Documentation]].
+For more information on notifications, see [[Notifications]].
 ==Configuring HipChat Notifications==
-Begin by navigating to ''Setup > Notifications'' and select the '''Configure''' button for HipChat.
+Begin by navigating to ''Setup > Notifications'' and clicking '''Configure''' for HipChat.
 [[File:Notifications HipChat.png]]
-Configure the HipChat module as follows:
+Configure the HipChat module:
-* '''API Token''' - The WHMCS HipChat integration requires a HipChat API V2 User Token. This allows WHMCS to communicate with all of your HipChat rooms. Enter your token here. If you don't have an API token, see below.
+* '''API Token''' — The WHMCS HipChat integration requires a HipChat API V2 User Token. This allows WHMCS to communicate with all of your HipChat rooms. Enter your token here. If you don't have an API token, see below.
-* '''API URL''' - ''Only required for HipChat Server users.'' If using HipChat Server, enter the URL to the API of your hosted instance. HipChat Cloud users should leave this field blank.
+* '''API URL''' — ''Only required for HipChat Server users.'' If using HipChat Server, enter the URL to the API of your hosted instance. HipChat Cloud users should leave this field blank.
-Once you're done, click '''Save Changes''' and WHMCS will attempt to verify the API Token provided. If the verification fails you will receive an error message. Check the API Token is entered correctly, has all the required scopes and try again. If successful, the modal will close and HipChat will change to active.
+Then, click '''Save Changes'''. WHMCS will attempt to verify the API token you provided.
-You are now ready to [[Notifications#Creating_a_Notification_Rule|Create Your First Notification Rule]].
+* If verification fails, you will receive an error message. Check that the API token is entered correctly and has all the required scopes before you try again.
+* If verification succeeds, HipChat will become active.
+Next, [[Notifications#Creating_a_Notification_Rule|Create Your First Notification Rule]].
 ====Creating an API Token inside HipChat====
-To create a new token, login to www.hipchat.com and navigate to Account Settings > API Access.  Under the '''Create new token''' heading, enter a label for the token and select both the '''View Room''' and '''Send Notification''' scopes.  Failure to select both of these will result in errors.
+To create a new token:
+# Log in to [www.hipchat.com] and go to '''Account Settings > API Access'''.
+# Under '''Create new token''', enter a label for the token.
+# Select both the '''View Room''' and '''Send Notification''' scopes.  Failure to select both of these will result in errors.
 [[File:Notifications HipChat APIToken.png]]