Difference between revisions of "Configuring Notifications with Slack"

From WHMCS Documentation
(→‎Creating an App for Slack)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
Configuring Notifications with Slack allows you to receive notifications in your Slack channels when events occur within WHMCS.
 
Configuring Notifications with Slack allows you to receive notifications in your Slack channels when events occur within WHMCS.
−
 
−
For more information on Notifications, please refer to the [[Notifications|Notifications Documentation]].
 
  
 
==Configuring Slack Notifications==
 
==Configuring Slack Notifications==
Line 11: Line 9:
 
===Creating an App for Slack===
 
===Creating an App for Slack===
  
−
1. Begin by logging into your Slack Workspace
+
To create a Slack app:
−
 
 
−
2. Visit https://api.slack.com/
 
−
 
 
−
3. Click the Start Building button to start the process of creating a new app. You will need to login if you haven't already.
 
−
 
 
−
4. Enter a name for the app. We recommend something like 'WHMCS'. Also choose the workspace you wish to add the app to. Then click continue.
 
−
 
 
−
5. Under the Add features and functionality heading, select the Permissions option
 
−
 
 
−
[[File:Slack_features.png|500px]]
 
−
 
 
−
6. Scroll down to Scopes: Bot Token Scopes
 
−
 
 
−
7. Click "Add an OAuth Scope" and assign the following permissions:
 
−
 
 
−
* channels:join
 
−
* channels:read
 
−
* chat:write
 
−
* groups:read
 
−
 
 
−
[[File:Slack_scopes.png|500px]]
 
  
−
9. Click Install App to Workspace
+
# Log in to your Slack Workspace.
 +
# Go to <tt>https://api.slack.com/</tt>.
 +
# Click '''Create an app'''. You will need to log in if you haven't already.
 +
# Select ''From scratch''.
 +
# Enter a name for the app. We recommend something like <tt>WHMCS</tt>.
 +
# Choose the workspace you wish to add the app to and click '''Continue'''.
 +
# Under '''Add features and functionality''', select ''Permissions''. <br/>[[File:Slack_features.png|500px]]
 +
# Scroll down to '''Scopes: Bot Token Scopes'''.
 +
# Click '''Add an OAuth Scope''' and assign the following permissions:
 +
#* '''channels:join'''
 +
#* '''channels:read'''
 +
#* '''chat:write'''
 +
#* '''groups:read''' <br/>[[File:Slack_scopes.png|500px]]
 +
# Click '''Install App to Workspace'''. <br/>[[File:Slack_install_to_workspace.png|500px]]
 +
# Confirm authorization for the permissions for the app that you just configured.
 +
# Copy the Bot User OAuth Access Token value. You will need this to enter in WHMCS. <br/>[[File:Slack_oauth.png|500px]]
 +
# In WHMCS, to go '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Notifications]]''' or, prior to WHMCS 8.0, '''Setup > Notifications'''.
 +
# Under the Slack notification provider, click '''Configure'''.
 +
# Paste the Bot User OAuth Access Token that you copied into '''OAuth Access Token'''.
 +
# Click '''Save Changes'''. <br/>[[File:Whmcs_slack_oauth.png|500px]]
  
−
[[File:Slack_install_to_workspace.png|500px]]
+
WHMCS will attempt to verify the OAuth Access Token provided and automatically join your App.  
  
−
9. Confirm you authorize the permissions for the app that you just configured.
+
* If the verification fails you will receive an error message. Check the Access Token is entered correctly, has all the required scopes and try again.  
−
 
+
* If successful, the modal will close and you will now be able to send notifications to Slack.
−
10. You will now be presented with the Bot User OAuth Access Token you need for WHMCS integration. Copy this value.
 
−
 
 
−
[[File:Slack_oauth.png|500px]]
 
−
 
 
−
11. Now return to WHMCS and navigate to Setup > Notifications.
 
−
 
 
−
12. Under the Slack notification provider, click Configure
 
−
 
 
−
13. Enter the Bot User OAuth Access Token you copied in step 10 into the OAuth Access Token input field and hit Save Changes to complete the process.
 
−
 
 
−
[[File:Whmcs_slack_oauth.png|500px]]
 
−
 
 
−
WHMCS will attempt to verify the OAuth Access Token provided and automatically join your App . If the verification fails you will receive an error message. Check the Access Token is entered correctly, has all the required scopes and try again. If successful, the modal will close and you will now be able to send notifications to Slack.
 
  
 
You are now ready to [[Notifications#Creating_a_Notification_Rule|Create Your First Notification Rule]].
 
You are now ready to [[Notifications#Creating_a_Notification_Rule|Create Your First Notification Rule]].
Line 59: Line 42:
  
 
====Private Channels====
 
====Private Channels====
 +
 
To send notifications in private channels, follow these extra steps:
 
To send notifications in private channels, follow these extra steps:
  
 
# Open the Slack app,
 
# Open the Slack app,
 
# Navigate to your private channel
 
# Navigate to your private channel
−
# Invite the app to the channel with the command:<div class="source-cli">/invite @app_name</div>Replace <tt>app_name</tt> with the name of your app, eg:<br/><br/>[[File:Slack invite app.png]]<br/>
+
# Invite the app to the channel with the command:<div class="source-cli">/invite @app_name</div>Replace <tt>app_name</tt> with the name of your app. For example:<br/><br/>[[File:Slack invite app.png]]<br/>
 
# Send the message
 
# Send the message
−
The app will join the private channel, and now be available for selection in WHMCS when [[Notifications#Creating_a_Notification_Rule|creating a Notification Rule]].
+
The app will join the private channel, and now be available for selection in WHMCS when [[Notifications#Creating_a_Notification_Rule|creating a notification rule]].

Latest revision as of 16:32, 19 December 2022

Configuring Notifications with Slack allows you to receive notifications in your Slack channels when events occur within WHMCS.

Configuring Slack Notifications

To enable WHMCS to communicate with the Slack API, WHMCS requires an OAuth Access Token.

You can create an OAuth Access Token quickly and easily by following the steps below.

Creating an App for Slack

To create a Slack app:

  1. Log in to your Slack Workspace.
  2. Go to https://api.slack.com/.
  3. Click Create an app. You will need to log in if you haven't already.
  4. Select From scratch.
  5. Enter a name for the app. We recommend something like WHMCS.
  6. Choose the workspace you wish to add the app to and click Continue.
  7. Under Add features and functionality, select Permissions.
    Slack features.png
  8. Scroll down to Scopes: Bot Token Scopes.
  9. Click Add an OAuth Scope and assign the following permissions:
    • channels:join
    •  channels:read
    •  chat:write
    •  groups:read
      Slack scopes.png
  10. Click Install App to Workspace.
    Slack install to workspace.png
  11. Confirm authorization for the permissions for the app that you just configured.
  12. Copy the Bot User OAuth Access Token value. You will need this to enter in WHMCS.
    Slack oauth.png
  13. In WHMCS, to go Configuration () > System Settings > Notifications or, prior to WHMCS 8.0, Setup > Notifications.
  14. Under the Slack notification provider, click Configure.
  15. Paste the Bot User OAuth Access Token that you copied into OAuth Access Token.
  16. Click Save Changes.
    Whmcs slack oauth.png

WHMCS will attempt to verify the OAuth Access Token provided and automatically join your App.

  • If the verification fails you will receive an error message. Check the Access Token is entered correctly, has all the required scopes and try again.
  • If successful, the modal will close and you will now be able to send notifications to Slack.

You are now ready to Create Your First Notification Rule.

WHMCS will attempt to automatically join your Bot to a Slack channel when one is defined in a Notification Rule.

Private Channels

To send notifications in private channels, follow these extra steps:

  1. Open the Slack app,
  2. Navigate to your private channel
  3. Invite the app to the channel with the command:
    /invite @app_name
    Replace app_name with the name of your app. For example:

    Slack invite app.png
  4. Send the message

The app will join the private channel, and now be available for selection in WHMCS when creating a notification rule.

Retrieved from "http://3.17.75.209/index.php?title=Configuring_Notifications_with_Slack&oldid=33732"