Documentation

Slack

Send change logs and alerts from the SURF Admin console into a Slack channel using an incoming webhook.

Before you start

RequirementDetail
Slack accessPermission to create an app in your Slack workspace and install it
SURF accessAdministrator on the SURF Admin console

Step 1: Create the Slack webhook

  1. Go to https://api.slack.com/apps
  2. Select Create New App in the top right.
  3. Choose From scratch.
  4. Enter an App Name, pick the workspace to develop it in, and click Create App.
  5. Under Add features and functionality, select Incoming Webhooks.
  6. Set Activate Incoming Webhooks to On.
  7. Select Add New Webhook to Workspace.
  8. Choose the channel the app should post to and click Allow.
  9. Copy the generated webhook URL. You will paste it into SURF.

Step 2: Configure the integration in SURF

  1. In SURF Admin, go to Settings → Integrations, select Slack and choose Update Integration.
  2. Paste the webhook URL into the relevant field or fields:
SettingPurpose
Send change logs to Slack channelConfiguration and policy changes made in the admin console
Send alert logs to Slack channelSecurity alerts raised by SURF
  1. Turn on the toggle for each type you want to receive. The two can use different webhook URLs, so change logs and alerts can go to separate channels.
  2. Click Submit and enable the integration.

Filtering what gets sent

Use Edit advanced filters in the integration dialog to narrow what reaches Slack. By default all alerts are sent until rules are defined.

Troubleshooting

SymptomCheck
Nothing arrives in SlackThe integration was submitted but left toggled off, or the toggle for that log type is off
Alerts arrive but change logs do notOnly one of the two webhook URL fields was filled in
Messages post to the wrong channelThe webhook is bound to the channel chosen when it was authorised. Create a second webhook for a different channel.

For anything not covered here, contact the SURF support team.