Getting Started with DeskDirector
DeskDirector Portals
Browser Support
What is the DeskDirector Admin Portal?
What is the DeskDirector Tech Portal
What is the DeskDirector Client Portal?
Desktop Portal
Managing Your Account
Admin Essentials
DeskDirector Features Overview
Logging in to DeskDirector
User Profiles & Profile Pictures
Managing Tickets with DeskDirector
Office Hours
Getting Started with the Solution Library
How Searching Works
Embedding Help Page Media
Get started with the DeskDirector Power Automate Connector
Features
Portal Customization
Forms
Service Catalogue
Communication
Email Connectors
Notifications
Email Notifications
Actionable Messages for Emails
Real-Time Chats
Email Template Engine
Surveys
Broadcasts
Generative AI
DeskDirector with Generative AI
Ticket Summary for TECH Portal
Setting up AI Service Providers
Microsoft Foundry for DeskDirector
Knowledge Bases for AI Assistants
Custom Tools for AI Assistants
AI Assistants in DeskDirector
Advanced
Login & Authentication
Contact Groups
Custom Domains
File Storage
Dashboard
Accounts
Contacts
Approvals
Tags
Task Lists
The Learning Center
Portal Deep Linking
Auditing & Analytics
Microsoft Power Automate
Actions
Solutions
Featured Solution: Teams Ticket Discussion
Power Automate Template Gallery
Featured Solution: Ticket Briefing
Power Automate Administration
DeskDirector Power Platform Connector Reference
Power Automate Connector - Setting up your first flow
Microsoft Teams App
Introducing the DeskDirector for Microsoft Team App
Installing the Microsoft Teams App (Client Mode)
Installing the Microsoft Teams App (TECH Mode)
Setting up Tags for Teams Discussions (TECH Portal)
Branding the DeskDirector Teams App
DeskDirector Teams App Notifications
Contact Groups Integration with Microsoft Teams
Setting up Content Security Policy (CSP)
Advanced topic: Setting up Tech & Client Mode in the same tenancy
Integrating Microsoft Teams with DeskDirector Tech Portal
Smart Alerts for TECH Users
Integrations
Developer Resources
Getting Started
What is the Toki Iti API
API Versions & Routes
Roles & Scopes
Authorization Options
Querying the API
How to Change an Entity Through the API
API Key Authorization
OAuth Fundamentals
Understanding OAuth for Tokity Integrations: Key Concepts
OAuth Authorization Code Flow: How an App Gets Access to Tokity
OAuth App Registration
How to Register an OAuth App to Integrate with Tokity
Choosing an OAuth App Type: Confidential vs. Public Apps and Client Secrets
OAuth Personal Secrets: What They Are and When to Use Them
OAuth Administration
Configuring OAuth Settings in Tokity
Managing OAuth Authorized Sessions and User Consent
Granting OAuth Admin Consent at the Root Level
API Response Control
Uploading Attachments (Ticket API)
The Prefer Header — Overview
Controlling Returned Data (Ticket API)
Controlling Returned Data (Form Result API)
Controlling Returned Data (Workspace API)
Workspace Ordering
How Workspace Ordering Works
Creating and Reordering Workspace Groups
Adding and Reordering Tickets in a Workspace Group
Data Sync & Notifications
Delta API: Tracking Changes Over Time
Webhooks vs. Events — Differences, When to Use Which
Verifying Webhook and Event Payloads (HMAC Signature)
Ticket Widgets
Ticket Widget: Overview
How the Widget Is Requested
Ticket Widget Anatomy and Styling
Ticket Widget Actions: Leading, Secondary and Primary
Ticket Widget: Progress Type
Ticket Widget: List Type
Ticket Widget: Description Type
Ticket Widget: Form Type
Ticket Widget: Control When a Widget Refreshes
Ticket Widget: Form Results and State Across Steps
Ticket Widget: Error Responses and Debugging
Ticket Widget: Building a Multi-Step Request
Glossary
Security
Troubleshooting
Troubleshooting via Web Developer Tools
Permissions & Access - Common Issues
Contact DeskDirector Support
Troubleshooting DeskDirector Connection Issues
Desktop Portal - Common Issues
Contact Impersonation
Approvals - Common Issues
Microsoft Teams App - Common Issues
Email & Email Delivery - Common Issues
Login & Authentication - Common Issues
DeskDirector Desktop App - Installation Issues
Table of Contents
- All Categories
- Features
- Generative AI
- Setting up AI Service Providers
Setting up AI Service Providers
Updated
by Niamh Ferns
Overview
DeskDirector supports integration with various generative AI service providers to enhance your ticketing system's AI capabilities. Before using any AI features in DeskDirector, you'll need to set up one of your preferred AI service providers. This knowledge base article will guide you through setting up different AI service providers.
Supported AI Service Providers
Provider | Ticket Summary | Tech Copilot | Client Portal Assistant | Smart Alert | Knowledge Base |
✅ | ✅ | ✅ | ✅ | ✅ | |
✅ | ✅ | ✅ | ✅ | ✅ | |
✅ | ✅ | ✅ | ✅ | ✅ | |
(with OpenAI-compatible API) | ✅ | ✅ | ✅ | ✅ | ❌ |
(with OpenAI-compatible API) | ✅ | ✅ | ✅ | ✅ | ❌ |
Setting Up AI Service Providers
- Navigate to the AI services integration settings page in your Admin Portal or within the DeskDirector Teams app

- Click on Manage your AI service providers
- Select the service provider type from a dropdown or click + Set Up New Provider

- Fill in the required configuration details

- Click Save to complete the setup
OpenAI Setup
Required Details
- Name (custom identifier for your configuration)
- API Key
- Model ID
- Optional: Organisation ID
Setup Steps
- Obtain an API Key from OpenAI's Platform
- Select your preferred model (e.g., gpt-3.5-turbo, gpt-4) from the available models
- Enter your Organisation ID if applicable
Official Documentation:
Azure OpenAI Setup
Required Details
- Name
- API Key
- Model ID
- Endpoint
- Deployment Name
Setup Steps
- Create and deploy an Azure OpenAI resource (model) in the Azure Portal via Azure AI Foundry
- Obtain your API key, endpoint, and deployment details from the deployed model (model name, model ID, deployment nameIn this screenshot, the deployment name and name are both
gpt-4o-mini.
- Enter the configuration informationNote: the endpoint will be the base endpoint, not the full target URI provided in the endpoint section. So if you have:
https://showroomaifoundry.cognitiveservices.azure.com/openai/deployments/gpt-4.1/chat/completions?api-version=2025-01-01-preview
Your endpoint in DeskDirector will be:https://showroomaifoundry.cognitiveservices.azure.com
Official Documentation:
Google AI Setup
Obtain Google API Key
Configuration Details
- Provider Type: Select Google
- Name: for example
Google Gemini - API Key: Your Google Gemini API key
- Model: for example
gemini-2.0-flash
Google-Specific Resources
Groq Setup
Obtain Groq API Credentials
- Visit Groq's Developer Platform
- Create an account or log in
- Generate an API key in the Credentials section
Configuration Details
- Provider Type: Select Other
- Name: for example
Groq AI - API Key: Your Groq API key
- Model ID: for example
llama2-70b-4096 - Endpoint:
https://api.groq.com/openai/v1
Groq-Specific Resources
Other (OpenAI-compatible) Providers
Required Details
- Name
- API Key
- Model ID
- Endpoint
Supported Providers
Providers with OpenAI-compatible APIs can be configured using this option, such as:
- Anthropic Claude
- Custom model servers
Note: Verify API compatibility before configuration
Best Practices
- Use the most appropriate model for your use case
- Monitor API usage and costs
- Regularly update your AI service provider configurations to take advantage of the newer or cost-effective models
Troubleshooting
- Ensure your API key is correct and active
- Ensure the large language model is valid
- Contact DeskDirector support for integration-specific issues and the vendors for the AI API-specific issues