LogoLogo
LearnDocumentationSupportCommunity
Version 6.30
Version 6.30
  • Welcome
  • Nexthink V6
  • Overview
    • Software components
    • Collector
    • Finder
    • Engine
    • Portal
    • Nexthink Library
    • Digital Experience Score
  • Installation and configuration
    • Planning your installation
      • Overview of the installation process
      • Hardware requirements
      • Connectivity requirements
      • Software requirements
      • Reference architectures
    • Installing Portal and Engine Appliances
      • Installing the Appliance
      • Installing the Appliance on Azure
      • Installing the Appliance on AWS
      • Installing the Appliance on OTC
      • Managing Appliance accounts
      • Setting the names of the Portal
      • Setting the names of the Engines
      • Specifying your internal networks and domains
      • Federating your Appliances
      • STIG compliance in Web Console
      • Connecting the Portal to the Engines
      • Configuring session performance storage
      • Configuring device performance storage
      • Setting up a software license
      • Sending email notifications from the Appliance
      • Allocating resources for the Portal
    • Installing the Collector
      • Installing the Collector on Windows
      • Installing the Collector on macOS
      • Installing the Collector for a Proof of Value
      • Assigning Collectors to Engines
      • Assignment of roaming Collectors
      • Collector MSI parameters reference table
      • Nxtcfg - Collector configuration tool
      • Inspecting the connection status of the Collector
      • Querying the status of the TCP connection of the Collector
      • Reporting the URL of HTTP web requests
      • Auditing logon events
      • Viewing user interactions in virtualized and embedded environments
      • Engage notifications on macOS
      • Configuring Collector level anonymization
    • Collector remote connectivity
      • Redirecting and anonymizing Collector traffic
      • Redirecting the Collector TCP channel
      • Support for DirectAccess
      • Windows Collector proxy support
      • Mac Collector proxy support
    • Installing the Event Connector
      • Installing the Event Connector on Linux
    • Installing the Finder
      • Installing the Finder on Windows
      • Enabling Cross-Engine Finder features
      • Expanding the time frame of investigations in the Finder
      • Enabling Finder access to the Library
      • Finder proxy support
    • Updating from V6.x
      • Updating the Appliance
      • Content centralization when updating the Appliance
      • Updating the Collector
      • Viewing Collector deprecated fields
      • Updating the Finder
    • Security and user account management
      • Importing and replacing certificates
      • Hierarchizing your infrastructure
      • Adding users
      • Enabling SAML authentication of users
      • Just-In-Time provisioning of user accounts
      • Enabling Windows authentication of users
      • Multi-factor authentication for local accounts overview
      • Provisioning user accounts from Active Directory
      • Establishing a privacy policy
      • Disabling local accounts for interactive users
      • Setting the complexity and minimum length of passwords for local accounts
      • Protecting local accounts against brute force attacks
      • Preventing password saving in the Finder
      • Controlling session timeouts in the Portal
      • Security settings in the Appliance
      • Setting the Do Not Disturb periods between campaigns
    • Data retrieval and storage
      • Data retention
      • Increasing the maximum number of metrics
      • Establishing a data retention policy in the Engine
      • Storing Engine data in a secondary disk drive
      • Importing data from Microsoft Active Directory
      • Setting the locale in the Portal
      • Changing the Time Zone of the Portal
      • Time Zones and data collection
      • Changing the data collection time of the Portal
      • Nightly task schedules timetable
      • Changing the thresholds of High CPU warnings
      • Automatic restart of unresponsive Engine
    • Maintenance operations
      • Logging in to the CLI
      • Special operation modes for the Engine and the Portal
      • Changing the default ports in the Appliance
      • Centralized Management of Appliances and Engines
      • Monitoring the performance of the Appliance
      • Resizing partitions in Appliance
      • Configuring the system log
      • Examining the logs in the Portal
      • GDPR - Retrieving or anonymizing personal data
      • Finding out unlicensed devices
      • Removing devices
      • Installing third-party software in the Appliance
      • Installing VMware Tools in the Appliance
      • Operational data sent to Nexthink
      • Sending additional data to Support
    • Disaster recovery
      • Planning for disaster recovery
      • Web Console backup and restore
      • Engine backup and restore
      • Portal backup and restore
      • Rule-based assignment backup and restore
      • License backup and restore
      • PKI backup and restore
    • Branding
      • Branding the Portal
      • Branding of campaigns
  • User manual
    • Getting started
      • Logging in to the Finder
      • Logging in to the Portal
      • Enabling STIG in Webconsole
    • Querying the system
      • Searching the subject of interest
      • Executing an investigation
      • Creating an investigation
      • Editing the options of an investigation
      • Combining logical conditions in investigations
      • Navigating through the results of an investigation
      • Properties of users and devices
    • Visualizing system activity in the Finder
      • Getting a quick overview
      • Graphically observing the activity of users and devices
      • Observing service performance
      • Viewing network connections
      • Viewing web requests
      • Viewing executions
    • Monitoring IT custom metrics
      • Creating a metric
      • Examples of metrics
      • Session performance
      • Device performance
      • Following the evolution of a metric
      • Finding the visuals of a metric
    • Monitoring IT services
      • Analyzing service quality
      • Creating a service
      • Following the evolution of a service
      • Specifying URL paths of web-based services
    • Engaging with the end user
      • Getting feedback from the end users
      • Types of campaigns
      • Creating a campaign
      • Editing a campaign
      • Types of questions
      • Controlling the flow of questions
      • Translating a campaign
      • Triggering a campaign manually
      • Limiting the reception rate of campaigns
      • Scrutinizing the results of a campaign
      • Continuously measuring the satisfaction of employees
    • Rating devices and users with scores
      • Computing scores
      • Creating a score
      • Checking and comparing ratings
      • Computing potential savings
      • Score XML Reference
      • Documenting scores
    • Remotely acting on devices
      • Scenarios for remote actions
      • Creating a remote action
      • Executing remote actions
      • Triggering a remote action manually
      • Writing scripts for remote actions on Windows
      • Writing scripts for remote actions on Mac
      • Example of self-healing scenario
      • Example of self-help scenario
      • Application control and remote actions
    • Organizing objects with categories
      • Classifying objects of the same type
      • Creating categories and keywords
      • Tagging objects manually
      • Tagging objects automatically
      • Importing tags from text files
    • Getting notified by the system
      • Receiving Engage campaigns
      • Receiving email digests
      • Receiving alerts
      • Creating a service-based alert
      • Creating an investigation-based alert
    • Building web-based dashboards
      • Introducing dashboards in the Portal
      • Creating a dashboard
      • Examining metrics in depth
      • Documenting dashboards
      • Assessing license use
      • Computing dashboard data
      • Reusing dashboard content
    • Importing and exporting authored content
      • Methods for reusing authored content
      • Manually sharing Finder content
      • Importing a content pack
      • Conflict resolution
      • Exporting a content pack
  • Library packs
    • Compliance
      • Device Compliance
    • Configuration Manuals
      • Overview (Configuration Manuals)
      • Installing A New Version Of A Library Pack
    • Digital Employee Score (DEX score)
      • DEX Score Installation And Configuration
      • Detailed Library Pack Changelog
    • Device management
      • Reduce logon duration
      • Group Policy Management
      • Hardware Asset Renewal
      • Hardware Asset Renewal Advanced
      • Application Auto-Start Impact
    • Remote Employee Experience
      • Remote Worker Experience
      • Home Networking
      • Change Log And Upgrade Process
      • Remote Worker Vs Office Worker Device Category
      • Remote Worker Insights
      • DEX V2 Upgrade Of Remote Worker
    • Persona Insight
      • Persona Insight - Overview
      • Persona Insight - Library Pack
      • Persona Insight - Score Only Pack
      • Persona Insight - Without Campaign pack
      • Persona Insight - Getting Started and Upgrade Procedure
      • Persona Insight - Configuration Guide
      • Persona Insight - Troubleshooting - Multiple devices on multiple engines
      • Persona Insight - Reference Guide
      • Persona Insight - Example Pack
      • Persona Insight - Device Sizing
        • Persona Insight - Device Sizing Overview
        • Persona Insight - Device Sizing Configuration
      • Persona Insight - Application Sizing
        • Persona Insight - Application Sizing Overview
        • Persona Insight - Application Sizing Configuration
      • Legacy Persona documentation
        • Persona Insight - Library Pack (V.1.0.0.0)
        • Persona Insight - Base Pack
        • Persona Insight - Base Pack Advanced
        • Persona Insight - Customization Guide (V1.0.0.0)
        • Persona Insight - Configuration Guide (V1.0.0.0)
        • Persona Insight - Reference Guide (V1.0.0.0)
    • GSuite
      • GSuite: Health
      • GSuite: Services
      • GSuite: Sentiment
      • GSuite: Advanced Health
    • Support
      • Support: Level 1
    • Shadow IT
      • Shadow IT
    • Malware Protection
      • Malware Protection
    • Office 365 Health
      • Office 365 Health: Overview
      • Office 365 Health: Services
    • Office 365 OneDrive
      • OneDrive Summary
      • OneDrive Operations
      • OneDrive Advanced Health
      • OneDrive Migration
      • OneDrive Sentiment
      • OneDrive Management
      • OneDrive Advanced Operations
    • Office 365 Teams
      • Teams Overall Configuration
      • Teams - Migration
      • Teams - Health
      • Teams - Advanced Health
      • Teams - Adoption
    • Microsoft 365 Apps
      • Microsoft 365 Apps - Operate
    • Employee Self Service
      • Overview
      • Configuration
      • Usage
    • Onboarding Experience Management
      • OEM - Overview
      • OEM - Configuration
    • Office 365 Outlook
      • Outlook Troubleshooting
    • Virtualization
      • Virtualization: Operate
      • Virtualization: AVD - Advanced
      • Virtualization: Citrix Advanced
      • Virtualization: Project
      • Virtualization: Troubleshooting
        • Virtualization: Troubleshooting: Configuration
    • Windows
      • Win10: Configuration
      • Win10: Migration
      • Win10: Feature Update
      • Win10: Quality Update
      • Windows Defender Management
      • Administrators Management
    • Windows 11
      • Windows 11 - Readiness
      • Windows 11 - Migration Pilot
      • Windows 11 - Migration
      • Windows 11 - Operate
    • Webex
      • Webex Operate
    • Zoom
      • Zoom Operate
    • Remote Actions
      • Get Performance Monitor Data
      • Skype For Business
      • Restart Device
      • Upload Logs to S3 using PreSigned URLs
    • Software Asset Optimization
    • Collaboration Optimization
      • Collaboration Optimization - Solution Overview
      • Collaboration Optimization - Configuration
      • Collaboration Optimization - Usage / Troubleshooting
    • Systems Management
      • Manage Configuration Drift
      • MS ConfigMgr - Client Health
        • MS ConfigMgr - Client Health - Summary
        • MS ConfigMgr - Client Health - Configuration Guide
      • Intune
        • Intune - Health
          • Intune - Health - Summary
          • Intune - Health - Configuration Guide
    • Return to the office
      • Return to the office - Planning
      • Return to the office - Readiness
    • Green IT
      • Green IT - Overview
      • Green IT - Configuration Guide
    • Hybrid Working
      • Hybrid Working Experience
      • Hybrid Working Experience - Installation and upgrade procedure
  • Integrations
    • Nexthink ServiceNow Service Graph Connector
      • Overview
        • Roles and Permissions
        • Modules
      • Installation and Configuration Guide
        • Pre-requisites
          • Configure Identification Rules
          • Import and setup the CMDB categories in Finder
        • Setup
          • Configure the connection
          • Configure import properties
          • Configure additional engines
          • Set up scheduled import jobs
      • Data transformation and mapping by default
      • How to customize the behaviour of the Connector
      • FAQ
        • Why ServiceNow Service Graph Connector?
        • What about Nexthink CMDB Connector?
        • Why is the name the primary key for the devices?
      • Troubleshooting
        • IRE identification issues
          • [No Choice found in the sys_choice table for the target table](integrations/nexthink-servicenow-service-graph-connector/troubleshooting/ire-identification-issues/ no-choice-found-in-the-sys_choice-table-for-the-target-table.md)
          • Identification rules not created
          • Discovery_source choice not created
        • Timeout Errors
          • ECCResponseTimeoutException
          • HTTP 0 error
        • MID server issues
          • java.lang.NullPointerException
          • MID Server memory issues
          • Not trusted certificates in Quebec release
        • Configure credentials issues
          • [Not allowing update of property authentication_choice](integrations/nexthink-servicenow-service-graph-connector/troubleshooting/configure-credentials-issues/ not-allowing-update-of-property-authentication_choice.md)
          • Invalid username/password combo (HTTP 401/403)
        • Configure Engines Issues
          • [The client secret supplied for a confidential client is invalid](integrations/nexthink-servicenow-service-graph-connector/troubleshooting/configure-engines-issues/ the-client-secret-supplied-for-a-confidential-client-is-invalid.md)
        • No Cis imported and no errors found in the log
    • Nexthink ServiceNow Incident Management Connector (IMC)
      • Installation and configuration guide (IMC)
      • Troubleshooting Guide (IMC)
      • Domain separation installation (IMC)
    • Nexthink ServiceNow CMDB Connectors
      • Installation and Configuration Guide
      • Troubleshooting Guide
      • Field transformation and normalisation examples
    • Nexthink Event Connector
      • High level overview
      • Installation and Configuration Guide
      • Troubleshooting guide
      • RPM installation
      • Splunk specific documentation
        • Upgrading from Splunk Connector to Event Connector
        • Splunk add-on installation and usage
    • Nexthink Chatbot SDK
      • Introduction and concepts
      • Installation, configuration and update guide
        • Installation and configuration
        • Update to newer version
        • Uninstallation
        • Authentication
        • Topics configuration
        • Remote action configuration
        • Advanced configuration
        • Additional resources and references
      • Dimensioning guide
      • Troubleshooting
      • Technical solution description
      • Downloads and release notes
  • Glossary and references
    • Search and information display
      • Search in Finder
      • Keyboard shortcuts for column display selection
      • Campaign display compatibility
      • Real-time and consolidated service data
      • Service errors and warnings
      • Errors and warnings for devices and executions
      • Types of widgets
      • Widget compute state in charts
      • Errors in the execution of remote actions
      • Top results of Cross-Engine investigations
      • Engine data history
    • Tooltips in the user and device views
      • Alerts tooltips
      • Warnings tooltips
      • Errors tooltips
      • Activity tooltips
      • Services tooltips
    • Database information and organization
      • Maximum supported values
      • Local and shared content
      • Device Identification
      • Local IP address of devices
      • Timestamping of events
      • Boot and logon duration
      • Application startup duration
      • Application not responding events
      • Memory and CPU usage
      • Status of TCP connections
      • Status of UDP connections
      • Network and port scan conditions
      • Binary paths
      • Maximum number of Binaries
      • Package Executable Mapping
      • Metro apps
      • Investigation with packages
      • Portal aggregation and grouping
      • Focus time metric
    • Security
      • Access rights and permissions
      • Active Directory authentication
      • Canonical domain names for Windows authentication
      • System alerts
      • Audit trail
      • Appliance hardening
      • STIG hardening
      • FIPS 140-2 compliance
      • Security bulletins
        • Is Nexthink affected by Okta breach
        • Is Nexthink affected by SolarWinds breach
        • Nexthink and Log4j - Security bulletin
        • CVE-2022-22965 - Security Vulnerability Spring4shell - Spring Framework
        • Version 6.22.2.10: Security Vulnerability Maintenance Release
        • The Collector V6.27.X Release – Security Bulletin
    • References
      • Components of the Collector
      • Server support
      • Compatibility mode
    • Glossary
      • Activity
      • Alert
      • Application
      • Binary
      • Campaign
      • Category
      • Connection
      • Dashboard
      • Destination
      • Device
      • Domain
      • Entity
      • Event
      • Executable
      • Execution
      • Focus time
      • Hierarchy
      • Installation
      • Investigation
      • Keyword
      • Metric
      • Module
      • Object
      • Package
      • Platform
      • Port
      • Printer
      • Score
      • Service
      • Session
      • System boot
      • User
      • User logon
      • Web request
      • Widget
  • API and integrations
    • Integrating with Nexthink
      • Event Connector
      • Getting data through the NXQL API
      • Bidirectional integration with the Finder
      • Count metrics API
      • Software metering API
      • Services API
      • List Engines API
      • GetSID API
      • Triggering campaigns via their API
      • Triggering remote actions via their API
      • Audit trail API
      • Integrating investigation-based alerts
      • Downloads
    • NXQL API
      • Introducing the NXQL API
      • NXQL Tutorial
      • NXQL language definition
      • NXQL Data Model
    • Integrations
      • Excel integration with NXQL
      • Power BI
      • Azure Data Lake Storage Gen2
      • Splunk Event Connector
    • ServiceNow
      • CMDB Connector
      • Incident Management Connector
      • Event Management

© Nexthink

  • Privacy policy
  • Responsible Disclosure Policy
On this page
  • Concepts and general architecture
  • Concepts
  • Nexthink Chatbot SDK general architecture
  • Basic diagram flow
  • Third-party chatbot requirements
  • Topics
  • Topic content
  • Example: OutlookIssues pseudo-code
  • Use cases
  • Chatbot Integration and REST API
  • Chatbot SDK Authentication
  • Usage of the API key
  • Generation of the API Key
  • Limitations

Was this helpful?

  1. Integrations
  2. Nexthink Chatbot SDK

Introduction and concepts

Last updated 10 months ago

Was this helpful?

This document provides comprehensive information about the introduction and concepts around Nexthink Chatbot SDK, its API and use cases. The information contained herein is subject to change without notice and is not guaranteed to be error-free. If you find any errors, please report them to us via . This document is intended for readers with a detailed understanding of Nexthink technology.

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

Concepts and general architecture

The purpose of the Nexthink Chatbot SDK is to provide smart diagnosis and automatic resolution of IT issues. This is accomplished by creating an abstraction layer in front of Nexthink that any chatbot vendor can integrate via a standard REST API.

Concepts

Intent

This is a general chatbot term referring to the employee’s intention. When an employee types “I have no (disk) space left in my computer,” the chatbot recognizes whether the input demonstrates an intent after processing it with natural language processing (NLP).

Natural Language Processing (NLP)

This is the algorithmic process that utilizes AI to translate a large amount of human language into a well-defined intent and to generate natural language from a given response. This activity is performed within the chatbot.

Conversational flow

This is a decision tree used by the chatbot to perform tasks such as retrieving more information from the employee or accessing external back-end servers. In general, the entry point is a given intent extracted from the NLP component.

Topic

This is a part of the configuration that represents a use case related to an intent within Chatbot SDK. It generally contains:

  • Diagnosis: a list of conditions to match (for example, free space < 10%)

  • Remediation: list of remote actions to launch if the diagnosis conditions match (for example, clean recycle bin)

Catalog

This is a collection of topics provided by Chatbot SDK. The collection has been created by analyzing Nexthink historical data about common device issues. Additionally, custom topics can be created by extending or changing the existing templates.

Nexthink Chatbot SDK general architecture

Chatbot SDK is an extra component of Nexthink’s core product and aims to add Nexthink intelligence to any chatbot. In order to achieve this objective, a REST API is provided that is accessible via a new endpoint.

Chatbot SDK is composed of several microservices which run as docker containers. The main functionality provided by Chatbot SDK:

  • Isolates internal Nexthink components.

  • Manages the chatbot authentication to access the REST API.

  • Identifies devices used by a particular employee and provides timing information about the last activity of the employee, such as employee interaction with the mouse or the keyboard.

  • Provides diagnosis and remediation to the chatbot in order to make decisions based on a specific topic and device. For example, this can occur when triggering remediations via the Chatbot SDK.

  • Caches information locally that is retrieved from Nexthink Engines in order to improve the response time. This information is updated via a scheduled discovery process.

Basic diagram flow

The following scenario illustrates a typical conversation between the employee and a chatbot integrated with Nexthink Chatbot SDK to solve an issue with Outlook.

  • The chatbot receives a complaint from the employee about Outlook not working properly.

  • The chatbot translates several inputs from NLP into an existing intent.

  • The specific intent is the entry for a conversational flow that comprises one or several Nexthink topics that can solve the issue.

  • Chatbot SDK learns which devices are affected based on the user id.

  • Once the device has been identified, Chabot SDK engages the topic that refers to Outlook issues

  • Nexthink Chatbot SDK analyzes all the configured diagnoses in the topic and returns the existing problems to the chatbot, which in this case are Outlook crashes. It reports two potential solutions:

    • Cleaning the local OST files

    • Removing non-standard plugins detected by Nexthink

  • The chatbot parses this information and presents the available options to the employee.

  • The employee chooses to clean the local files and the related remediation action reported by Nexthink is called through the API for Nexthink Chatbot SDK to launch a remote action.

To report the status of the remote action execution, which can take up to 2 minutes, it is recommended to use an ITSM ticket. We recommend leaving the task of creating tickets to the chatbot if it is capable of doing so.

  • (Optional) By performing a call to Chatbot SDK, the chatbot will be able to report the execution result back.

Third-party chatbot requirements

To integrate Nexthink Chatbot SDK with a third-party chatbot, the chatbot must support the following:

  • Integration capabilities with a REST API and the ability to process answers in JSON format

    • Authentication to connect to the REST API is based on an API key exchange

Conversational flow definition to call one or several Nexthink topics which have been given an intent and decision making based on the answers

  • Transformation of Chatbot SDK responses to natural language to render a proper answer to the employee

  • Chatbot ability to configure timers to wait up to 1 minute for diagnosis results in some cases

Topics

A topic is a part of the configuration in the Chatbot SDK, where a list of diagnosis and resolution options are listed. It is usually related to high-level employee issues such as PCSlow or OutlookIssues to simplify the integration on the chatbot side.

The chatbot only needs to know the available topics in Chatbot SDK and call them with the REST API. Refer to the REST API for more information.

Topic content

  • Every topic has a version and a list of diagnoses to check.

  • A diagnosis can be performed by either requesting information via an NXQL query or by triggering a remote action.

    • In some cases, it can be left empty if there is no automatic way to fix it, for example, a battery with bad health. This could be used to open an incident or to route to a Live Agent on the chatbot side.

    • It is recommended to substitute the use of remote actions as a diagnosis with an NXQL query that retrieves the same information that the remote action provides. This means that the remote action must be first executed in the device for the information to be available. Thus, the administrator will be responsible for scheduling the necessary remote actions. This configuration is used to shorten the time it takes to receive an answer about a certain diagnosis from the chatbot. When a remote action has been previously launched, the chatbot will be able to access the necessary information more quickly than if the remote action is executed in real-time. This approach only makes sense for certain remote actions, as the information provided is not purely real-time. Therefore, gathering data on a daily basis would be enough for this use case.

    • When the topic is retrieving remote action information via NXQL queries, it is recommended to validate the remote action status by adding a “where” clause in the query itself in order to check the Execution Status.

  • A diagnosis has a condition to match, for example, Used Disk Space > 85% The correct clause can be either a single element or a literal expression. In the first case, declaring either a single word or a number is allowed, and in the second case, a string composed of two or more words is allowed.

Example: OutlookIssues pseudo-code

Purpose: Detect and fix the most common Outlook issues

Issue1: Outlook crash

Code
Diag1: check crashes  
RA1: reset OST

Issue2: Outlook offline

Code
Diag2: check Outlook is offline 
RA2: set Outlook online 

Issue3: Outlook outdated version

Code
Diag3:  check Outlook version 
RA3: Trigger GPO update 

Use cases

This is an initial list of topics available in the out-of-the-box catalog:

  • Outlook Issues – related to outdated versions, Outlook offline

  • Health check – related to PC health (disk space, battery, …)

  • L1 Checklist – L1 Scores related to PC health like CPU, disk space, office365 status, etc.

  • PC Slow – related to disk space, start-up apps, etc.

  • Skype for Business – related to Skype for Business health

  • OneDrive Issues – related to OneDrive common errors and installation

  • OneDrive Installation – checks if OneDrive is installed. It can be installed if required.

  • Print Issues – resets the print spooler

These out-of-the-box use cases can be extended by adding new topics configuration.

Chatbot Integration and REST API

Chatbot SDK Authentication

The authentication required for a chatbot to integrate with Chatbot SDK is API Key based.

Usage of the API key

  • At any time, you can use a unique valid API Key.

  • The Chatbot will need to use the key as an authentication method by adding an HTTP extended header "X-API-key:” in every REST API call.

Generation of the API Key

Internally, the API key is generated based on the Nexthink user and password configured during the Chatbot SDK installation process. For this reason, the recommended way to integrate a chatbot is to use a Nexthink user with a fixed password dedicated for chatbot integration.

Every time the Nexthink password or user is changed in the .env, the key needs to be regenerated and updated in the chatbot. This can be done with a scripted approach.

This generated key needs to be shared with the chatbot integrator.

Limitations

Nexthink Chatbot SDK is not part of the official cloud offering at this point. This means that, although it can be configured to interact with Nexthink Cloud deployments, Chatbot SDK itself still needs to be deployed and installed as part of the on-premises infrastructure of the client.

Authentication and authorization of the employee: the chatbot is responsible for authenticating and authorizing the employee. The user identification must be shared with Chatbot SDK through the Nexthink user identifier based on the .

Nexthink Chatbot SDK offers a standard following the OpenAPI v3.0 standard.

For more information about how to generate the Key, refer to the page.

Nexthink Support Portal
Nexthink data schema
REST API
Authentication
High-level architecture
Basic diagram flow