> For the complete documentation index, see [llms.txt](https://atlas.anywhere.now/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://atlas.anywhere.now/channels-integrations/dialogue-ai-assist/configure-dialogue-ai-assist.md).
# Configure Dialogue AI Assist
Configure Dialogue AI Assist connection settings, WebAgent exposure, and validation for chat and voice scenarios.
Configure Dialogue AI Assist only after the required WebAgent and channel prerequisites are available for the UCC. The exact endpoint, secret, dashboard URL, and access model are environment-specific.
{% hint style="warning" %}
Configure Dialogue AI Assist `PluginSettings` on the UCC Config page on SharePoint. Use only endpoint and secret values supplied through the approved delivery or support process for the UCC.
{% endhint %}
## Before you begin
Verify the following before you change configuration:
* For Dialogue Cloud Neo, Dialogue AI Assist requires an applicable AI-minute package. Confirm that your subscription includes the required package with your AnywhereNow representative. For on-premises licensing requirements or renewal questions, contact your AnywhereNow representative.
* The Dialogue AI Assist request path is confirmed for the customer environment.
* WebAgent is enabled for the UCC.
* WebAgentService settings are configured.
* A Microsoft Entra ID app registration is configured for Deepdesk single sign-on (SSO). For the required app registration, redirect URIs, token claims, Microsoft Graph delegated permissions, admin consent, and optional app roles, see [Configure Microsoft Entra ID for Deepdesk SSO](/channels-integrations/dialogue-ai-assist/configure-microsoft-entra-id-for-deepdesk-sso.md).
* For WebChat scenarios:
* Dialogue Manager is configured.
* WebChat Dialogue Provider 2 is configured.
* For voice scenarios:
* Dialogue Studio is available for the UCC.
* The required transcription capability is available, if voice setup for the environment depends on it.
* WebAgent is not embedded in Microsoft Teams for the Dialogue AI Assist voice scenario, unless product support confirms that embedded use is supported.
* The Dialogue AI Assist endpoint, webhook URL, and any required secret values have been supplied through the approved delivery or support process.
* You have a non-production or controlled test path for validation.
{% hint style="info" %}
Use the release prerequisites supplied through the approved delivery or support process for the UCC. Complete Deepdesk SSO setup before users sign in with Microsoft Entra ID.
{% endhint %}
## Configure PluginSettings in SharePoint
Dialogue AI Assist uses UCC-level `PluginSettings` for the backend connection to the external assistant service.
1. Open the UCC Config page on SharePoint.
2. Open the **Plugin Settings** list.
3. Validate or configure the relevant `PluginSettings` for the UCC.
{% tabs %}
{% tab title="Chat: DC2024.01 or lower" %}
Use scope `Aviator`.
| Required `PluginSettings` | Value guidance |
| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Enabled` | Enables the Dialogue AI Assist integration. Use the value approved for the UCC. |
| `WebhookUri` | Use the webhook URL supplied for the UCC. The value must be an absolute HTTP or HTTPS URL. |
| `EncryptedWebhookSecret` | Stores the encrypted secret used with the webhook. Configure only through the approved secret-handling process. Do not expose or enter plain-text secrets. |
| {% endtab %} | |
{% tab title="Chat: DC2024.02 or higher" %}
Use scope `Deepdesk`.
| Required `PluginSettings` | Value guidance |
| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Enabled` | Enables the Dialogue AI Assist integration. Use the value approved for the UCC. |
| `WebhookUri` | Use the webhook URL supplied for the UCC. The value must be an absolute HTTP or HTTPS URL. |
| `EncryptedWebhookSecret` | Stores the encrypted secret used with the webhook. Configure only through the approved secret-handling process. Do not expose or enter plain-text secrets. |
| {% endtab %} | |
{% tab title="Voice" %}
Use scope `Deepdesk`.
| Required `PluginSettings` | Value guidance |
| ------------------------- | ------------------------------------------------------------------------------------------ |
| `Enabled` | Enables the Dialogue AI Assist integration. Use the value approved for the UCC. |
| `WebhookUri` | Use the webhook URL supplied for the UCC. The value must be an absolute HTTP or HTTPS URL. |
| {% endtab %} | |
| {% endtabs %} | |
## Configure WebChat scenarios
1. Confirm that Dialogue Manager is enabled and reachable for the UCC.
2. Confirm that WebChat Dialogue Provider 2 is configured and that test WebChat dialogues can reach WebAgent.
3. Confirm the Dialogue AI Assist webhook URL and secret values for the environment.
4. On the UCC Config page on SharePoint, open the **Plugin Settings** list.
5. Add or update the required Dialogue AI Assist `PluginSettings` for the chat release:
* For DC2024.01 or lower, use `Enabled`, `WebhookUri`, and `EncryptedWebhookSecret` with scope `Aviator`.
* For DC2024.02 or higher, use `Enabled`, `WebhookUri`, and `EncryptedWebhookSecret` with scope `Deepdesk`.
6. Confirm that `WebhookUri` is an absolute HTTP or HTTPS URL.
7. Confirm that `EncryptedWebhookSecret` contains only an encrypted secret and does not expose the plain-text secret value.
8. Save the configuration.
9. Start a controlled WebChat dialogue in WebAgent.
10. Confirm that the assistant functionality appears only for the intended UCC and channel.
## Configure voice scenarios
Voice setup uses Dialogue Studio to forward event and transcript information to Dialogue AI Assist.
1. Confirm that Dialogue Studio is available for the UCC.
2. Confirm that any required transcription capability is available and tested.
3. Configure the Dialogue Studio flow integration on [Integrate Dialogue AI Assist with Dialogue Studio](/channels-integrations/dialogue-studio-integrations/integrate-dialogue-ai-assist-with-dialogue-studio.md).
4. On the UCC Config page on SharePoint, open the **Plugin Settings** list.
5. Add or update `Enabled` and `WebhookUri` with scope `Deepdesk`.
6. Confirm that `WebhookUri` is an absolute HTTP or HTTPS URL.
7. Save the configuration.
8. Validate with a controlled voice dialogue before production use.
{% hint style="warning" %}
Validate voice setup with a controlled dialogue before production exposure. Confirm that the intended UCC has the `Deepdesk` scope settings and that unsupported channels do not expose Dialogue AI Assist.
{% endhint %}
## Expose Dialogue AI Assist in WebAgent
For environments that use the new WebAgent layout, enable the Dialogue AI Assist widget only after the backend setup is complete.
1. Confirm that the approved WebAgent layout is active for the UCC.
2. Follow the WebAgent administration labels shown in the customer environment for widget configuration.
3. Enable the Dialogue AI Assist or Deepdesk widget in the approved layout option for the environment.
4. Save the WebAgent layout configuration.
5. Sign in to WebAgent with a test user who is assigned to the UCC.
6. Confirm that the widget appears for the intended channel and not for unsupported channels.
{% hint style="info" %}
Exact WebAgent widget labels and two-widget or four-widget layout names must match the product UI for the customer environment. If the labels differ, follow the WebAgent administration guidance supplied for the environment.
{% endhint %}
## Validate the configuration
Run these checks before production exposure:
1. Confirm that the correct UCC has the Dialogue AI Assist settings.
2. Confirm that no unsupported channel has the assistant enabled.
3. For WebChat, run a test WebChat dialogue and confirm that the assistant responds as expected in WebAgent.
4. For voice, run a controlled voice dialogue and confirm that Dialogue Studio sends the required event and transcript information.
5. Confirm that missing or invalid webhook values fail safely and do not block the planned fallback route.
6. Confirm that the approved support or delivery process includes webhook-secret rotation and incident handling.
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://atlas.anywhere.now/channels-integrations/dialogue-ai-assist/configure-dialogue-ai-assist.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
