Difference between revisions of "Configuring Notifications with HipChat"

From WHMCS Documentation

(Creating an API Token inside HipChat)
(Creating an API Token inside HipChat)
Line 25: Line 25:
 
To create a new token:
 
To create a new token:
  
# Log in to [[http://www.hipchat.com HipChat]] and go to '''Account Settings > API Access'''.   
+
# Log in to [http://www.hipchat.com HipChat] and go to '''Account Settings > API Access'''.   
 
# Under '''Create new token''', enter a label for the token.
 
# 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.
 
# Select both the '''View Room''' and '''Send Notification''' scopes.  Failure to select both of these will result in errors.
  
 
[[File:Notifications HipChat APIToken.png]]
 
[[File:Notifications HipChat APIToken.png]]

Revision as of 15:15, 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.

Notifications HipChat.png

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 URLOnly 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:

  1. Log in to HipChat and go to Account Settings > API Access.
  2. Under Create new token, enter a label for the token.
  3. Select both the View Room and Send Notification scopes. Failure to select both of these will result in errors.

Notifications HipChat APIToken.png