NCP
  • Network Copilot
  • What's New?
  • Quick Start
  • Getting Started
    • System Requirements
      • On-Prem Deployment
      • Cloud Deployment
    • Licensing
    • Metrics Matrix
    • Onboarding Data
    • Scalability
  • Downloading Network Copilot
  • Deploying & Managing Network Copilot
    • Deployment Prerequisites
    • Installing Prerequisite Packages
    • Deploying the NCP Package
    • Managing Network Copilot
      • Upgrading License
      • Upgrading NCP
      • Uninstalling NCP
  • Web UI Administration
    • License Activation
    • Login Page
    • Dashboard Overview
    • Inventory Management
      • Onboarding Switches
        • Using ONES Telemetry Agent
        • Using SNMP
          • Adding Switches using YAML
          • Adding Switches using CSV
        • Using sFlow
        • Using API
        • Using gNMI
    • User Accounts
  • Accessing NCP
  • External Integrations
    • Communication & Collaboration
      • NetBox
      • Cisco Nexus Dashboard
      • Slack
    • Data Ingestion
      • AWS S3
      • Azure
      • ELK Stack
      • Google Cloud Storage
      • InfluxDB
      • Loki
      • Snowflake
      • Splunk
  • Use Cases
    • Basic NetOps
    • Flow Analytics
    • Security Audits
    • Inventory Insights
    • Support Knowledge Base
    • Upgrade Compliance
  • Contact Aviz Networks Support
Powered by GitBook
On this page
  • Procedure:
  • Setting up the Slack Bot
  • Add the OAuth Slack token to NCP
  • Add the NCP-bot to your Workspace

Was this helpful?

Export as PDF
  1. External Integrations
  2. Communication & Collaboration

Slack

PreviousCisco Nexus DashboardNextData Ingestion

Last updated 23 days ago

Was this helpful?

This guide provides step-by-step instructions for creating a Slack bot that allows you to talk to your Network Copilot from Slack. The bot can respond to queries about generating Compliance reports, Audit reports, and general chat about your network.

Enhance efficiency and streamline communication within your Slack channels.

Procedure:

Setting up the Slack Bot

  1. Create a Slack APP

    • Visit and log in with your organization ID

    • Click on "Create New App" and choose "From Scratch"

    • Name your app and select the target workspace from the dropdown menu

    • Click on "Create App"

  2. Setup permissions

    • In the left navigation bar, go to Features → OAuth & Permissions → Bot Token Scopes

    • Click on "Add an OAuth Scope"

    • Add the following permissions: chat:write, app_mentions:read, files:write, incoming-webhook, users:read

  3. Configure Event Subscriptions

    • Go to Features → Event Subscriptions and enable the feature

    • Enter your API endpoint URL (ex. -> https://<server-public-ip>:9001/api/v1/slack-events/questions)

    • Scroll down and subscribe to the following bot events: app_mentions:read

    • Click Save Changes

  4. Install the APP

    • Go back to OAuth & Permissions and click Install App to Workspace

    • Select the Channel for NCP-bot to post on

    • Click on Allow

Add the OAuth Slack token to NCP

  1. Obtain the OAuth token from Slack

    • Navigate to Slack API -> Your APPs -> Select the NCP-App -> Features -> OAuth & Permissions -> Bot User OAuth Token

    • In the features section, select 'Bot User OAuth Token' and copy the token

  2. Configure the NCP with the Slack token

    • Login to the NCP GUI

    • Go to Settings → Data Connectors → Messaging section

    • Click on Add Channel

    • Enter the 'Channel Name' and the 'Bot User OAuth Token'

    • Click Save

Add the NCP-bot to your Workspace

  1. Adding the NCP-Bot

    • Go to the settings of the desired channel or group

    • Navigate to Integrations → Apps -> Add an App

    • Select your app from the dropdown menu

  2. Interacting with the NCP-Bot

    • Begin a conversation with the bot by typing @your_bot_name followed by your query

Slack API
Setup a Slack bot for NCP
Add the OAuth Slack token to NCP
Add the NCP-bot to your workspace
Audit Report through Slack
Audit Report through Slack
Audit Report through Slack
General Chat through NCP