Slack Notifications Integration¶

Slack notification integration setup guide.

Overview¶

Faraday can send notification messages directly to users via Slack DM. This requires creating a Slack App with the correct permissions and configuring both the Slack OAuth token (admin) and individual Slack user IDs.

Key Characteristics¶

Prerequisites¶

• A Faraday Corporate License with notifications enabled.
• Slack workspace with admin access to install apps.
• Faraday administrator account to configure the OAuth token.

Step 1: Create the Slack App¶

1. Go to https://api.slack.com/apps.
2. Click Create New App.
3. Select From an app manifest.
4. Choose the Slack workspace where you want to install the app.

Step 2: Paste the App Manifest¶

In the manifest step, paste the following JSON:

{
    "display_information": {
        "name": "faraday-notifications",
        "description": "Notifications for Faraday",
        "background_color": "#82AFD9"
    },
    "features": {
        "app_home": {
            "home_tab_enabled": false,
            "messages_tab_enabled": true,
            "messages_tab_read_only_enabled": true
        },
        "bot_user": {
            "display_name": "Faraday Notifications",
            "always_online": true
        }
    },
    "oauth_config": {
        "scopes": {
            "bot": [
                "app_mentions:read",
                "channels:join",
                "channels:read",
                "chat:write",
                "chat:write.customize",
                "chat:write.public",
                "im:write",
                "links:write",
                "reactions:write",
                "team:read",
                "usergroups:read",
                "users:read",
                "users:write"
            ]
        }
    },
    "settings": {
        "event_subscriptions": {
            "bot_events": [
                "app_mention"
            ]
        },
        "interactivity": {
            "is_enabled": true
        },
        "org_deploy_enabled": false,
        "socket_mode_enabled": true,
        "token_rotation_enabled": false
    }
}

Step 3: Create the App and Install¶

1. Click Create.
2. Navigate to OAuth & Permissions in the left sidebar.
3. Click Install to Workspace (or "Install Org-wide" for Enterprise Grid).
4. Authorize the requested permissions.
5. Copy the Bot User OAuth Token — you will need this for Faraday configuration. The token starts with xoxb-.

Step 4: Add the App to Your Workspace¶

1. In Slack, open the channel list or use the Add apps option.
2. Search for faraday-notifications and add it.

Step 5: Get Your Slack Member ID¶

Each user who wants Slack notifications must provide their Slack member ID:

1. Open Slack.
2. Click on your profile picture (top right).
3. Click Profile.
4. Click the more button (three dots / ⋯).
5. Select Copy member ID.

The member ID looks like U01ABCDEF23.

Step 6: Configure Faraday (Administrator)¶

The Faraday administrator configures the OAuth token: 1. Click the user icon (top-right corner of Faraday web interface). 2. Select Preferences. 3. Navigate to the Notifications section under Integrations in the left panel. 4. In the Slack configuration area, paste the Bot User OAuth Token in the Oauth Token field. obtained in Step 3. 5. In the Slack configuration area, paste the member ID in the Slack ID field. 6. Click Save.

Shortcut: From Notification Settings, use the Configure integrations shortcut button to be redirected directly to Preferences > Notifications > Slack.

Step 7: Configure Faraday (Each User)¶

Non-administrator users only need their Slack ID:

1. Click the user icon (top-right corner of Faraday web interface).
2. Select Preferences.
3. Navigate to the Notifications section under Integrations in the left panel.
4. In the Slack configuration area, paste the member ID in the Slack ID field.
5. Click Save.

Note: For the integration to work, an administrator must have already pasted the OAuth token into their own Faraday account. Non-admin users only need to enter their Slack member ID.

Step 8: Enable Slack Channels¶

1. Go to the Notifications section in the left panel.
2. For each desired category, enable the SLACK column toggle.
3. Notifications for enabled categories will now be sent as Slack DMs.

Troubleshooting¶

Slack Notifications Not Arriving¶

Verifying the Setup¶

1. Check OAuth token: Ensure the token in Faraday Preferences starts with xoxb-.
2. Check Slack ID format: Member IDs start with U followed by alphanumeric characters (e.g., U01ABCDEF23).
3. Test notification: Enable a category with SLACK enabled, then trigger an action (e.g., create a comment) to verify delivery.

Security Considerations¶

• OAuth tokens are sensitive credentials. Store them securely and rotate periodically.
• The Slack bot can send messages to any user in the workspace via their member ID. Ensure only authorized Faraday administrators can set the OAuth token.
• Notifications may contain vulnerability details. Review your organization's data handling policies before enabling Slack notifications for sensitive categories.