Set up Slack notifications

If you’d like to receive cPFence v4+ on Enhance alerts on your desktop or mobile via Slack, follow the steps below. This guide uses the Slack desktop app.

You need access to your Slack workspace and permission to add an app. In cPFence, you need Manage Notification Settings for each server you configure.

Step 1: Install Slack

If you don’t already have it, download the Slack apps for both PC and mobile, then sign in to the same workspace on both devices.

Step 2: Create a Slack channel

1. Open the Slack desktop app.
2. Click + Add channels in the left sidebar and choose Create a channel. In layouts that put this under the + button, select Channel instead.

Open the channel creation menu. Select the image to enlarge it; use your browser’s Back command to return.

3. Choose Blank channel if Slack offers templates, then click Next.

Start with a blank alerts channel. Select the image to enlarge it; use your browser’s Back command to return.

4. Name your channel, for example cpfence-alerts. Choose its visibility and click Create.

Use a channel your alert recipients can access; the screenshot shows a public channel. Select the image to enlarge it; use your browser’s Back command to return.

Private alerts channel

Server alerts can contain security and server details. Use a private channel if only your administrators should see them. You must belong to that channel before adding its webhook.

Step 3: Create a Slack app with webhook access

1. Visit Slack’s app dashboard and log in to the intended workspace.
2. Click Create an App. If you already have an app for these alerts, open it and continue with Step 4.

Create the app that will deliver your alerts. Select the image to enlarge it; use your browser’s Back command to return.

3. Choose From a manifest.

Use the manifest method from the original setup guide. Select the image to enlarge it; use your browser’s Back command to return.

4. Pick your workspace and click Next.

Select the workspace containing your alerts channel. Select the image to enlarge it; use your browser’s Back command to return.

5. Select the JSON tab and paste the following manifest. Replace Your Hosting Co with the name you want for the app:

{
  "display_information": {
    "name": "Your Hosting Co"
  },
  "settings": {
    "org_deploy_enabled": false,
    "socket_mode_enabled": false,
    "is_hosted": false,
    "token_rotation_enabled": false
  }
}

Enter your app name in the manifest, then select Next. Select the image to enlarge it; use your browser’s Back command to return.

6. Click Next, review the app summary, then click Create. If your workspace requires app approval, ask its administrator to approve the app before continuing.

Review the selected app configuration before creating it. Select the image to enlarge it; use your browser’s Back command to return.

The manifest creation method is also covered in Slack’s app-manifest instructions.

Step 4: Enable incoming webhooks

1. In your app settings, open Incoming Webhooks and turn Activate Incoming Webhooks on.

Enable incoming webhooks for this app. Select the image to enlarge it; use your browser’s Back command to return.

2. Click Add New Webhook to Workspace (shown as Add New Webhook in the original screenshot).

Add a webhook for the channel you created. Select the image to enlarge it; use your browser’s Back command to return.

3. Choose #cpfence-alerts and click Allow or Authorize, depending on the dialog. Check that the selected workspace and channel are correct.

Authorize this app to post in the selected alerts channel. Select the image to enlarge it; use your browser’s Back command to return.

Step 5: Copy the webhook URL

Slack returns you to Incoming Webhooks and shows a new entry under Webhook URLs for Your Workspace. Click Copy beside that webhook URL.

Copy your own webhook URL privately; the example’s secret is concealed. Select the image to enlarge it; use your browser’s Back command to return.

The webhook URL is a secret

Anyone holding it can post to its channel. Keep it out of screenshots, tickets, shared notes and command arguments. If it is exposed, revoke it in Slack and create a replacement.

For workspace approval or webhook issues, see Slack’s incoming-webhook instructions.

Step 6: Configure the webhook in cPFence

1. In your cPFence WebUI, open System Settings.
2. Choose the intended Server scope, then select Notification Settings. Settings are saved for one server at a time.
3. Type Slack in Search settings to find the switch and webhook connection.
4. Turn Slack notifications on and click Save changes. Check the save result before continuing.
5. Under Delivery connections → Slack webhook, paste the URL you copied. Click Save changes again. Saving a webhook while Slack is enabled sends a test notification.

The current WebUI has Slack enabled and a configured connection on Local scope. The empty input keeps the saved URL; this screenshot does not show a submitted change or delivered test. Select the image to enlarge it; use your browser’s Back command to return.

6. Open your Slack channel and confirm that the cPFence test message arrived. A saved setting or submitted request alone does not confirm delivery.
7. Clear the search and review the event switches you want enabled in Notification Settings. The related protection module must also be enabled for its events to occur.

Keep or replace the saved connection

Leaving the webhook field blank preserves its saved URL. Saving a URL while Slack notifications are off does not send a test. Enable Slack first, then submit the intended webhook to test it.

For secondary servers, repeat the setup on each intended server, or use Apply to servers…. Review the selected destinations and changed fields before applying. Check each server’s result and test message; one successful server does not establish success for the whole cluster.

Set up Slack using the CLI instead

As root on the server you want to configure, run these commands in order:

cpfence --slack-notifications-on
cpfence --set-slack-webhook

Enter your webhook URL at the interactive prompt, rather than putting it in the command. Check the command result and confirm the test message in Slack. Repeat on each intended server; these commands configure the server where you run them.

To stop sending Slack alerts later:

cpfence --slack-notifications-off

Bonus: Adjust notification settings

To receive mobile push alerts, open Slack and configure its notification preferences:

1. Click your profile picture, then Preferences.

Open your own Slack notification preferences. Select the image to enlarge it; use your browser’s Back command to return.

2. Open Notifications and choose your notification schedule and sound preferences.

Choose the hours when you want notifications; the example schedule is a user choice, not a cPFence default. Select the image to enlarge it; use your browser’s Back command to return.

3. Open the alerts channel and check its notification preferences so new alerts notify you.
4. On your phone, sign in to the same workspace, enable Slack notifications in the phone’s settings, and check Slack’s mobile notification preferences. If messages appear in the channel but your phone is silent, check paused notifications and the notification schedule.

Use only Slack notifications (optional)

If you prefer to keep your email inbox clean and manage alerts in Slack:

1. Confirm that the Slack test arrived first.
2. In System Settings → Notification Settings on the intended server, clear Notification email and click Save changes.
3. Leave Slack notifications on and keep the intended event switches enabled.

If you prefer the configuration-file method from the original guide, set this line in /opt/cpfence/config.conf on the intended server:

EMAIL_RECIPIENT=""

Use the configuration file editor and check the save result. Preserve all other settings. To receive email again, follow email and SMTP setup and confirm delivery.

Troubleshooting

• Cannot create the app or authorize the channel: check workspace app approval and your membership of a private channel.
• No test message: check the save or command result, server connection, Slack enablement and whether the URL belongs to the intended workspace/channel. Do not disable email until Slack delivery is confirmed.
• Webhook refused: check whether the webhook was revoked or its channel archived. Create a replacement and save it privately.
• Test arrives but an event does not: check the owning module, event switch and notification cooldown. A test does not trigger every event.
• Message arrives but there is no mobile alert: check Slack’s channel preferences, notification schedule and your phone’s notification permissions.

Need further assistance? Open a support ticket through your client portal.