Difference between revisions of "Configuring Notifications with HipChat"
From WHMCS Documentation
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
Configuring HipChat notifications allows you to receive notifications in your HipChat rooms when events occur in WHMCS. | Configuring HipChat notifications allows you to receive notifications in your HipChat rooms when events occur in WHMCS. | ||
| − | |||
| − | |||
==Configuring HipChat Notifications== | ==Configuring HipChat Notifications== | ||
| − | Begin by navigating to ''Setup > Notifications'' and clicking '''Configure''' for HipChat. | + | Begin by navigating to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Notifications]]''' or, prior to WHMCS 8.0, '''Setup > Notifications''' and clicking '''Configure''' for HipChat. |
[[File:Notifications HipChat.png]] | [[File:Notifications HipChat.png]] | ||
| Line 19: | Line 17: | ||
* If verification succeeds, HipChat will become active. | * If verification succeeds, HipChat will become active. | ||
| − | Next, [[Notifications#Creating_a_Notification_Rule| | + | Next, [[Notifications#Creating_a_Notification_Rule|create your first notification rule]]. |
====Creating an API Token inside HipChat==== | ====Creating an API Token inside HipChat==== | ||
| Line 25: | Line 23: | ||
To create a new token: | To create a new token: | ||
| − | # Log in to [www.hipchat.com] 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]] | ||
Latest revision as of 20:58, 19 April 2022
Configuring HipChat notifications allows you to receive notifications in your HipChat rooms when events occur in WHMCS.
Configuring HipChat Notifications
Begin by navigating to Configuration () > System Settings > Notifications or, prior to WHMCS 8.0, 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 HipChat 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.
