Configuring Notifications with Slack

From WHMCS Documentation

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 Documentation.

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

1. Begin by logging into your Slack Workspace

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

Slack features.png

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

Slack scopes.png

9. Click Install App to Workspace

Slack install to workspace.png

9. Confirm you authorize 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.

Slack oauth.png

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.

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, eg:

    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.