Configuring Notifications with Slack - Revision history

SarahK: /* Creating an App for Slack */

2022-12-19T16:32:28Z

‎Creating an App for Slack

AlexN: /* Creating an App for Slack */

2022-12-14T13:09:21Z

‎Creating an App for Slack

SarahK at 21:02, 19 April 2022

2022-04-19T21:02:51Z

John at 12:19, 26 February 2021

2021-02-26T12:19:52Z

John: /* Creating an App for Slack */

2021-02-26T11:55:03Z

‎Creating an App for Slack

John: /* Creating an App for Slack */

2021-02-25T09:59:28Z

‎Creating an App for Slack

Chance at 18:36, 22 June 2020

2020-06-22T18:36:50Z

PeterB at 16:59, 2 June 2020

2020-06-02T16:59:45Z

PeterB: DOCS-6972

2020-06-02T16:09:58Z

DOCS-6972

Andrew at 14:17, 7 April 2020

2020-04-07T14:17:47Z

@@ Line 11: / Line 11: @@
 To create a Slack app:
-. Log in to your Slack Workspace.
+# Log in to your Slack Workspace.
+# Go to <tt>https://api.slack.com/</tt>.
-. Go to https://api.slack.com/.
+# Click '''Create an app'''. You will need to log in if you haven't already.
+# Select ''From scratch''.
-. Click '''Create an app'''. You will need to log in if you haven't already.
+# 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'''.
-. Select '''From scratch'''.
+# Under '''Add features and functionality''', select ''Permissions''. <br/>[[File:Slack_features.png|500px]]
+# Scroll down to '''Scopes: Bot Token Scopes'''.
-. Enter a name for the app. We recommend something like ''WHMCS''. Choose the workspace you wish to add the app to and click '''Continue'''.
+# Click '''Add an OAuth Scope''' and assign the following permissions:
+#* '''channels:join'''
-. Under the '''Add features and functionality''' heading, select the '''Permissions''' option.
+#* '''channels:read'''
+#* '''chat:write'''
-[[File:Slack_features.png|500px]]
+#* '''groups:read''' <br/>[[File:Slack_scopes.png|500px]]
+# Click '''Install App to Workspace'''. <br/>[[File:Slack_install_to_workspace.png|500px]]
-. Scroll down to '''Scopes: Bot Token Scopes'''.
+# 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]]
-. Click '''Add an OAuth Scope''' and assign the following permissions:
+# 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'''.
-* channels:join
+# Paste the Bot User OAuth Access Token that you copied into '''OAuth Access Token'''.
-* channels:read
+# Click '''Save Changes'''. <br/>[[File:Whmcs_slack_oauth.png|500px]]
 WHMCS will attempt to verify the OAuth Access Token provided and automatically join your App.
@@ Line 71: / Line 47: @@
 # Open the Slack app,
 # 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
 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]].

@@ Line 15: / Line 15: @@
 . Go to https://api.slack.com/.
-. Click '''Start Building'''. You will need to log in if you haven't already.
+. Click '''Create an app'''. You will need to log in if you haven't already.
-. Enter a name for the app. We recommend something like ''WHMCS''. Choose the workspace you wish to add the app to and click '''Continue'''.
+. Select '''From scratch'''.
-. Under the '''Add features and functionality''' heading, select the '''Permissions''' option.
+. Enter a name for the app. We recommend something like ''WHMCS''. Choose the workspace you wish to add the app to and click '''Continue'''.
 [[File:Slack_features.png|500px]]
 . Scroll down to '''Scopes: Bot Token Scopes'''.
 . Click '''Add an OAuth Scope''' and assign the following permissions:
 * channels:join
@@ Line 38: / Line 40: @@
 [[File:Slack_install_to_workspace.png|500px]]
 . Confirm authorization for the permissions for the app that you just configured.
 . 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]]
 . 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'''.
 . Enter the Bot User OAuth Access Token you copied in step 10 into the OAuth Access Token input field.
 . Click '''Save Changes'''.
 [[File:Whmcs_slack_oauth.png|500px]]

@@ Line 1: / Line 1: @@
 Configuring Notifications with Slack allows you to receive notifications in your Slack channels when events occur within WHMCS.
 ==Configuring Slack Notifications==
@@ Line 11: / Line 9: @@
 ===Creating an App for Slack===
-. Begin by logging into your Slack Workspace
+To create a Slack app:
-. Visit https://api.slack.com/
+. Log in to your Slack Workspace.
-. Click the Start Building button to start the process of creating a new app. You will need to login if you haven't already.
+. Go to https://api.slack.com/.
-. 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.
+. Click '''Start Building'''. You will need to log in if you haven't already.
-. Under the Add features and functionality heading, select the Permissions option
+. Enter a name for the app. We recommend something like ''WHMCS''. Choose the workspace you wish to add the app to and click '''Continue'''.
 [[File:Slack_features.png|500px]]
-. Scroll down to Scopes: Bot Token Scopes
+. Scroll down to '''Scopes: Bot Token Scopes'''.
-. Click "Add an OAuth Scope" and assign the following permissions:
+. Click '''Add an OAuth Scope''' and assign the following permissions:
 * channels:join
@@ Line 34: / Line 34: @@
 [[File:Slack_scopes.png|500px]]
-. Click Install App to Workspace
+. Click '''Install App to Workspace'''.
 [[File:Slack_install_to_workspace.png|500px]]
-. Confirm you authorize the permissions for the app that you just configured.
+. Confirm authorization for the permissions for the app that you just configured.
 . 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]]
-. Now return to WHMCS and navigate to Setup > Notifications.
+. 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
+. Under the Slack notification provider, click '''Configure'''.
-. 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.
+. Enter the Bot User OAuth Access Token you copied in step 10 into the OAuth Access Token input field.
 [[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.
 You are now ready to [[Notifications#Creating_a_Notification_Rule|Create Your First Notification Rule]].
@@ Line 59: / Line 64: @@
 ====Private Channels====
 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/>
 # 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]].

← Older revision		Revision as of 12:19, 26 February 2021
Line 57:		Line 57:

	WHMCS will attempt to automatically join your Bot to a Slack channel when one is defined in a 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:<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
		+	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]].

@@ Line 29: / Line 29: @@
 * channels:join
 * channels:read
-* chat:write:bot
+* chat:write
 * groups:read

@@ Line 21: / Line 21: @@
 [[File:Slack-permissions.png]]
-. On the following screen, scroll or auto-search to the Scopes section and add the following scopes:
+. On the following screen, scroll or auto-search to the Scopes section and add the following bot token scopes:
 * Access information about user’s public channels (''channels:read'')
 * Join channels in the workspace (''channels:join'')
-* Send messages as WHMCS (''chat:write:bot'')
+* Send messages as WHMCS (''chat:write'')
 * Access information about user's private channels (''groups:read'')