# Integrations

Integrations are the credentials layer of your Workspace. They store the API keys, endpoints, and OAuth credentials Helvia uses to reach external providers: LLMs, knowledge sources, live chat platforms, CRMs, and identity providers. Set them up here once and reuse them across multiple agents.

```mermaid
graph LR
    I[Integration] -->|credentials| P[Plugin]
    P -->|capability| A[Agent]
    I -.->|direct use| F[Knowledge Base / SSO / Voice]

      style I fill:#615DEC,stroke:#615DEC,color:#fff
      style P fill:#f0f0f7,stroke:#615DEC,color:#615DEC
      style A fill:#f0f0f7,stroke:#615DEC,color:#615DEC                                                                     
      style F fill:#f0f0f7,stroke:#615DEC,color:#615DEC,stroke-dasharray: 5 5
```

Configure your credentials at **Workspace > Integrations**, then link the integration to a [plugin](/build/plugins.md) on an agent, or directly to a Workspace feature like Knowledge Base, SSO, or Speech.

<div data-with-frame="true"><figure><img src="/files/2REb6tYgzYjfklAEGIle" alt=""><figcaption></figcaption></figure></div>

### How Integrations Work

Integrations enhance your AI agents with additional functionality by connecting them to external tools and services. Create one per Workspace, then any plugin or feature that needs that service can reuse it. Setup needs vary by integration.&#x20;

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><h4><i class="fa-arrows-rotate">:arrows-rotate:</i></h4><h4>Workspace-wide reuse</h4></td><td>One credential set serves everything. Create an integration once and every plugin or Workspace feature that needs that service can pick it up.</td></tr><tr><td><h4><i class="fa-puzzle-piece">:puzzle-piece:</i></h4><h4>Plugin activation</h4></td><td>Agents reach the integration through a plugin. Turn the plugin on for an agent and point it at your integration.</td></tr><tr><td><h4><i class="fa-lock">:lock:</i></h4><h4>Secret handling</h4></td><td>Credentials stay masked once saved. Anyone with edit access to the Workspace, however, can view and change the secrets.</td></tr><tr><td><h4><i class="fa-circle-exclamation">:circle-exclamation:</i></h4><h4>No automatic validation</h4></td><td>Helvia does not test your credentials on save. A wrong key or expired token only surfaces when the integration is actually used, so always test it end-to-end.</td></tr></tbody></table>

### Managing Integrations

All integrations live in **Workspace > Integrations**. The table shows every integration alongside its scope, description, and tags.

<div data-with-frame="true"><figure><img src="/files/kaMueBSNMe14TMooPXLL" alt="" width="563"><figcaption></figcaption></figure></div>

#### Adding an Integration

{% stepper %}
{% step %}

#### Find the Integration

Click on **Add Integration** and select the application scope (for example **LLM** or **CRM**) to find the Integration you need.
{% endstep %}

{% step %}

#### Name the Integration

Enter a **Name**, optional **Description**, and any **Tags**. These fields are common to every integration and used for organizational purposes only.
{% endstep %}

{% step %}

#### Configure the credentials

Enter the credentials and configuration for your provider. Required fields are marked, and secret fields like API keys are masked. See [Integration Scope](#integration-scope) for provider-specific setup notes.

{% hint style="warning" %}
Helvia does not validate your credentials when you save the integration. A wrong key, expired token, or typo in an endpoint goes undetected until the agent or feature actually tries to use it. Double-check the values, and test the integration end-to-end before relying on it in production.
{% endhint %}
{% endstep %}

{% step %}

#### Create the Integration

Click **Create Integration**. The integration is now available across the Workspace and can be linked to plugins or features.
{% endstep %}
{% endstepper %}

#### Editing an Integration

Click any integration or use the edit icon <i class="fa-pen">:pen:</i> in its **Actions** column, to open it. Secret fields stay masked: type a new value to overwrite them, or leave them as-is to keep the existing one. You can't save while a required field is empty. Once saved, every plugin or feature using the integration picks up the change automatically.

{% hint style="danger" %}
Anyone with [edit access](/administration/users-and-roles.md#workspace-access-roles-1) to the Workspace can view, modify, or reuse stored integration credentials in the Workspace. Granting edit access means trusting that user with every credential stored here.
{% endhint %}

#### Deleting an Integration

To remove an integration, use the delete action <i class="fa-trash-can">:trash-can:</i> in its **Actions** column and confirm. Once deleted, any plugin still linked to the integration stops working, and the agents that depend on those plugins might break. Make sure nothing is using the integration before deleting.

### Integration Scope

Each scope groups providers that serve the same purpose in the platform. Pick a scope when creating an integration, then choose the specific provider.

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><h4><i class="fa-microchip">:microchip:</i></h4><h4>LLM</h4></td><td>Connect LLM providers to power the LLM node, semantic search, language detection, and session analytics.</td><td><a href="/pages/OtcDYSj75LLHNgHnB5mz#llm-1">/pages/OtcDYSj75LLHNgHnB5mz#llm-1</a></td></tr><tr><td><h4><i class="fa-book-blank">:book-blank:</i></h4><h4>Knowledge Base</h4></td><td>Sync external document libraries into your agents' retrieval index (RAG).</td><td><a href="/pages/OtcDYSj75LLHNgHnB5mz#knowledge-base-1">/pages/OtcDYSj75LLHNgHnB5mz#knowledge-base-1</a></td></tr><tr><td><h4><i class="fa-headset">:headset:</i></h4><h4>LiveChat</h4></td><td>Route conversations to a third-party live chat platform when a human takes over from your agent.</td><td><a href="/pages/OtcDYSj75LLHNgHnB5mz#livechat-1">/pages/OtcDYSj75LLHNgHnB5mz#livechat-1</a></td></tr><tr><td><h4><i class="fa-address-card">:address-card:</i></h4><h4>CRM</h4></td><td>Pull customer records from your CRM into agent and LiveChat sessions for context.</td><td><a href="/pages/OtcDYSj75LLHNgHnB5mz#crm-1">/pages/OtcDYSj75LLHNgHnB5mz#crm-1</a></td></tr><tr><td><h4><i class="fa-microphone">:microphone:</i></h4><h4>Speech</h4></td><td>Power speech-to-text and text-to-speech on voice-enabled deployments.</td><td><a href="/pages/OtcDYSj75LLHNgHnB5mz#speech-1">/pages/OtcDYSj75LLHNgHnB5mz#speech-1</a></td></tr><tr><td><h4><i class="fa-shield-halved">:shield-halved:</i></h4><h4>SSO</h4></td><td>Let your team sign in to the Helvia Console with your own identity provider.</td><td><a href="/pages/OtcDYSj75LLHNgHnB5mz#sso-1">/pages/OtcDYSj75LLHNgHnB5mz#sso-1</a></td></tr><tr><td><h4><i class="fa-ticket">:ticket:</i></h4><h4>Ticketing</h4></td><td>Create and update support tickets directly from agent conversations and LiveChat sessions.</td><td><a href="/pages/OtcDYSj75LLHNgHnB5mz#ticketing-1">/pages/OtcDYSj75LLHNgHnB5mz#ticketing-1</a></td></tr></tbody></table>

{% hint style="success" %}
**Setup varies by provider** Each integration has its own configuration form. If you encounter any problem with a setup, you can reach out to [support](/resources/support.md).
{% endhint %}

### LLM

LLM integrations are the most important integrations on the platform: they power your AI agents themselves. Without one configured, your agents have no model to reason with, so set up an LLM integration as one of the first steps in a new Workspace. Used in various place across the platform:

* LLM node
* Semantic Search (RAG)
* Language Detection
* Session Analysis
* Automated Testing

<details>

<summary><strong>OpenAI</strong></summary>

Standard OpenAI API access.

**Required fields:**

* **API Key**: Your OpenAI API key

</details>

<details>

<summary><strong>Azure</strong></summary>

Azure deployments through Microsoft AI Foundry.

**Required fields:**

* **API Key**: The API key from your Azure resource
* **Endpoint**: The host endpoint from your Azure resource

</details>

<details>

<summary><strong>Gemini</strong></summary>

Google's Gemini family of models via the Gemini API.

**Required fields:**

* **API Key**: Your Google AI Studio API key

</details>

{% hint style="info" %}
**OpenAI-compatible providers** Connect any OpenAI-compatible provider such or Mistral AI or DeepSeek through an OpenAI integration. Set the **Custom Base URL** field to the provider's endpoint and use their API key; the integration then behaves like a standard OpenAI integration everywhere it's used.
{% endhint %}

### Knowledge Base

Knowledge Base integrations sync your internal documents, files, and other knowledge sources into Helvia Knowledge Base sources, so you don't have to upload them one by one. Once connected, agents can retrieve passages from the synced content at runtime, powering RAG search across the platform.

Each KB integration also exposes processing options that control how documents are parsed, chunked, and indexed for retrieval, so you can tune the behaviour per source.

<details>

<summary><strong>Dynamics 365 KB</strong></summary>

Knowledge articles published in your Dynamics 365 instance. Because the content is article-based rather than document-based, this integration doesn't expose processing options; articles are imported as-is.

**Required fields:**

* **Minor Version**: The minor version of your Dynamics 365 deployment

</details>

<details>

<summary><strong>SharePoint KB</strong></summary>

Microsoft 365 document libraries. After filling in the configuration, click the **Authorize** button at the top of the form to complete Microsoft OAuth authorization. The **Create Integration** button stays disabled until authorization succeeds.

**Required fields:**

* **Site URL**: The URL of the SharePoint site holding your documents
* **Document Libraries**: The libraries within that site to include in the sync

</details>

<details>

<summary><strong>Azure Blob Storage KB</strong></summary>

Container-based document storage. The form displays a read-only **Webhook URL**: configure it in your Azure Blob Storage account so changes to your container trigger an immediate sync into Helvia.

**Required fields:**

* **Account Name**: Your Azure storage account name
* **Container Name**: The blob container holding the documents
* **SAS Token**: A shared access signature (SAS) with read access to the container

</details>

### LiveChat

LiveChat integrations route conversations to a third-party live chat platform when a human takes over from your AI agent. The handoff carries the session context across so the human picks up where the agent left off.

<details>

<summary><strong>Cisco Customer Collaboration</strong></summary>

Hand off conversations to a Cisco contact center.

**Required fields:**

* **Client ID**: OAuth client ID for your Cisco app
* **Client Secret**: OAuth client secret for your Cisco app
* **CCX Queue Tag**: Tag identifying the Cisco CCX queue to route chats to
* **Chat ID**: Identifier of the chat application in Cisco
* **Endpoint**: The Cisco service endpoint URL

</details>

<details>

<summary><strong>Zendesk Livechat</strong></summary>

Route conversations into Zendesk via the Sunshine Conversations API.

**Required fields:**

* **Zendesk Base URL**: The base URL of your Zendesk instance
* **Sunshine App ID**: The Sunshine Conversations app ID
* **Sunshine Conversations Key ID**: API key ID from Sunshine Conversations
* **Sunshine Secret**: API secret paired with the key ID
* **Webhook ID**: The webhook ID registered in Sunshine Conversations
* **Webhook Key**: The secret used to validate webhook callbacks

</details>

<details>

<summary><strong>Genesys</strong></summary>

Hand off conversations to a Genesys contact center.

**Required fields:**

* **Genesys OAuth app client ID**: Client ID of your Genesys OAuth app
* **Genesys OAuth app client secret**: Client secret of your Genesys OAuth app
* **Genesys organization region**: The domain only (for example, `mypurecloud.ie`)
* **Genesys Open Messaging integration ID**: The Open Messaging integration ID in Genesys
* **Webhook Key**: The secret used to validate webhook callbacks

</details>

{% hint style="success" %}
Helvia LiveChat does not require an integration. It works out of the box with no Workspace setup.
{% endhint %}

### CRM

CRM integrations pull existing customer records into agent and LiveChat sessions, so conversations start with full context about who the user is.

<details>

<summary><strong>Dynamics 365 CRM</strong></summary>

Read customer records from your Dynamics 365 instance.

**Required fields:**

* **Minor Version**: The minor version of your Dynamics 365 deployment

</details>

### Speech

Speech integrations power speech-to-text and text-to-speech on voice-enabled deployment channels, so your agents can hold spoken conversations.

<details>

<summary><strong>Azure Speech</strong></summary>

Microsoft Azure speech-to-text and text-to-speech services.

**Required fields:**

* **Region**: The Azure region of your Speech resource
* **Subscription Key**: The subscription key from your Azure Speech resource<br>

</details>

### SSO

SSO integrations let your team sign in to the Helvia Console with your identity provider instead of email and password.

<details>

<summary><strong>OpenID</strong></summary>

Any OpenID Connect-compatible identity provider.

**Required fields:**

* **OpenID Configuration URL**: The discovery document URL of your identity provider
* **Grant Type**: The OAuth grant type used to obtain tokens (for example, `authorization_code`)
* **Client ID**: The client ID registered for Helvia in your identity provider

</details>

### Ticketing

Ticketing integrations let LiveChat human agents create and update support tickets directly from a conversation.

<details>

<summary><strong>Zendesk Ticketing</strong></summary>

Create and update tickets in Zendesk Support.

**Required fields:**

* **Base URL**: The base URL of your Zendesk instance
* **Username**: The Zendesk user account the integration acts as
* **Token**: An API token from Zendesk paired with the username

</details>

### Best Practices

* **Tag your environments**: Apply tags like `prod`, `sandbox`, or a team name to keep credentials organized as your Workspace grows
* **Set up integrations first**: Plugins won't show available providers until at least one matching integration exists
* **Reuse, don't duplicate**: A single integration can serve multiple plugins across multiple agents
* **Rotate credentials in place**: Update the existing integration rather than creating a new one, so every plugin linked to it picks up the new credentials automatically

{% hint style="success" %}
You now know what integrations do, how to create and manage them, and how they connect to plugins and other Workspace features.
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.helvia.ai/administration/integrations.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
