Difference between revisions of "Configuring Notifications with Slack"
| 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. | ||
| − | |||
| − | |||
==Configuring Slack Notifications== | ==Configuring Slack Notifications== | ||
| Line 11: | Line 9: | ||
===Creating an App for Slack=== | ===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 '''Start Building'''. You will need to log in if you haven't already. | |
| − | 5. Under the Add features and functionality heading, select the Permissions option | + | 4. Enter a name for the app. We recommend something like ''WHMCS''. Choose the workspace you wish to add the app to and click '''Continue'''. |
| + | |||
| + | 5. Under the '''Add features and functionality''' heading, select the '''Permissions''' option. | ||
[[File:Slack_features.png|500px]] | [[File:Slack_features.png|500px]] | ||
| − | 6. Scroll down to Scopes: Bot Token Scopes | + | 6. Scroll down to '''Scopes: Bot Token Scopes'''. |
| − | 7. Click | + | 7. Click '''Add an OAuth Scope''' and assign the following permissions: |
* channels:join | * channels:join | ||
| Line 34: | Line 34: | ||
[[File:Slack_scopes.png|500px]] | [[File:Slack_scopes.png|500px]] | ||
| − | 9. Click Install App to Workspace | + | 9. Click '''Install App to Workspace'''. |
[[File:Slack_install_to_workspace.png|500px]] | [[File:Slack_install_to_workspace.png|500px]] | ||
| − | 9. Confirm | + | 9. Confirm authorization for the permissions for the app that you just configured. |
10. You will now be presented with the Bot User OAuth Access Token you need for WHMCS integration. Copy this value. | 10. You will now be presented with the Bot User OAuth Access Token you need for WHMCS integration. Copy this value. | ||
| Line 44: | Line 44: | ||
[[File:Slack_oauth.png|500px]] | [[File:Slack_oauth.png|500px]] | ||
| − | 11. | + | 11. 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'''. |
| − | 12. Under the Slack notification provider, click Configure | + | 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 | + | 13. Enter the Bot User OAuth Access Token you copied in step 10 into the OAuth Access Token input field. |
| + | |||
| + | 14. Click '''Save Changes'''. | ||
[[File:Whmcs_slack_oauth.png|500px]] | [[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. | + | 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 64: | ||
====Private Channels==== | ====Private Channels==== | ||
| + | |||
To send notifications in private channels, follow these extra steps: | To send notifications in private channels, follow these extra steps: | ||
| Line 65: | Line 71: | ||
# 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, eg:<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 | + | 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]]. |
Revision as of 21:02, 19 April 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 Start Building. You will need to log in if you haven't already.
4. Enter a name for the app. We recommend something like WHMCS. Choose the workspace you wish to add the app to and click Continue.
5. Under the Add features and functionality heading, select the Permissions option.
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
9. Click Install App to Workspace.
9. Confirm authorization for the permissions for the app that you just configured.
10. You will now be presented with the Bot User OAuth Access Token you need for WHMCS integration. Copy this value.
11. In WHMCS, to go Configuration () > System Settings > Notifications or, prior to WHMCS 8.0, 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.
14. Click Save Changes.
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:
- Open the Slack app,
- Navigate to your private channel
- Invite the app to the channel with the command:/invite @app_nameReplace app_name with the name of your app, eg:
- Send the message
The app will join the private channel, and now be available for selection in WHMCS when creating a notification rule.