Skip to main content

​
Overview

Honeydew Analyst Bot for Microsoft Teams is a conversational AI tool that helps you analyze your data in Microsoft Teams. You can ask questions about your data, get insights and visualizations without leaving your Teams account.

​
Installation

To make the Honeydew app available in Microsoft Teams, follow these two main steps:
  1. Upload the app manifest file (requires a user with permission to submit apps).
  2. Admin approval and publishing (performed by a Microsoft Teams administrator).

​
Step 1: Upload the App Manifest File

The first step is to submit the app to your organization for approval.
Steps
1

Open Microsoft Teams

  • Open the Microsoft Teams app.
  • Click on the Apps button on the left sidebar.
2

Go to Manage your apps

  • In the Apps menu, scroll down and select “Manage your apps”.
3

Upload the App

  • Click on “Upload an app” at the top of the page.
4

Submit the app

Steps
  • Download the app manifest file.
  • Select “Submit an app to your org” to send it for IT admin approval and upload the app manifest file.
5

Confirm Submission

Steps
  • A confirmation message will appear: “Request submitted to your admin”.
  • Click “View your requests” to check the status of your submission.

​
Step 2: Admin Approval & Publishing

Once the app is uploaded, a Microsoft Teams admin must approve and publish it.
Admin Manage Apps
1

Open Microsoft Teams Admin Center

2

Navigate to Manage Apps

  • In the left sidebar, expand “Teams Apps” and click “Manage apps”.
3

Find the Honeydew App

  • Use the search bar to find Honeydew.
  • The app will be listed under Pending Approval.
4

Select the App

  • Click on Honeydew to open its details page.
5

Publish the App

Admin Manage Apps
  • Click “Publish” to approve and deploy the app to your organization.
Admin Manage Apps
  • A confirmation message will appear—click “Publish” again to finalize.
6

Verify App Availability

  • Once published, the app will be available in Microsoft Teams for users in the organization.

​
Configuration

After the app is published, an administrator configures the agent before anyone can use it. Send honeydew-config to the Honeydew agent (as a direct message or by addressing it with @Honeydew in a channel) and click Configure Settings (or Edit Configuration) to open the configuration form.

​
Authentication Methods

The Honeydew Analyst agent for Microsoft Teams supports three authentication modes: OAuth Only (Recommended): Each user authenticates with their own Honeydew account. This allows personalized experiences and access control. It also enables using individual Snowflake credentials when the Snowflake OAuth authentication method is configured for your organization, enforcing data access policies at the user level. API Key Only (Legacy): All users share a single service API key and secret. Use this if you want to make the agent available without requiring each user to have a Honeydew account. Hybrid (Channel-Based): OAuth by default, with specific channels using the shared API key. List the channel IDs that should use API key authentication; all other channels use OAuth.

​
Configuration Steps

  1. Send honeydew-config to the agent and click Configure Settings (or Edit Configuration) to open the form.
  2. Fill in the following details:
    • Authentication Mode: Choose OAuth Only, Hybrid, or API Key Only (see above).
    • API Key (Optional): Leave blank to use OAuth. Enter your API key to use API Key authentication.
    • API Secret (Optional): Required only if API Key is set. Leave blank for OAuth.
    • Base URL: The base URL of your Honeydew instance, typically https://api.honeydew.cloud. If your organization uses a custom Honeydew URL, you would be provided with this information along with the app installation package.
    • Workspace: The Honeydew workspace the agent connects to (required).
    • Agent: The agent the bot uses for analysis.
    • Domain (deprecated if Agent is set): A domain to use instead of an agent. Either an Agent or a Domain must be provided; setting an Agent is recommended.
    • API Key Channels: Used only in Hybrid mode. Comma-separated channel IDs that use API key authentication; all other channels use OAuth.
  3. Click Save. A confirmation message appears showing the updated settings.

​
Prerequisites

Important: If using Snowflake Cortex as the LLM platform, ensure the Snowflake Cortex Prerequisites are met, before using the Honeydew Analyst Bot for Microsoft Teams

​
Usage

Once the Honeydew Analyst agent is installed and configured, you can start using it in Microsoft Teams.

​
Direct Conversations

Open a direct chat with the Honeydew agent and send your question. In OAuth mode, the first time you ask a question the agent sends a Sign In to Honeydew card — sign in once with your Honeydew account to continue.

​
Conversations in a Channel

To ask questions in a channel, add the agent to the channel and address it directly using @Honeydew.
Continue asking follow-up questions on the agent’s answer by replying in the same thread. To ask a new question without the previous context, start a new thread.

​
Logout (OAuth Mode Only)

When using OAuth authentication, send honeydew-logout to sign out of your Honeydew account. This disconnects your account from the agent, and you’ll need to re-authenticate to continue.

​
Useful Tips

  1. Treat it as a conversation: Sometimes AI will need additional context to answer well. Use follow-up questions to narrow down the data.
  2. Ask detailed questions: The more context you provide in your question, the better the bot can understand and provide accurate answers.
  3. Ask for possible values before asking to filter: If you asked for data with filter and the bot returned nothing, a common root cause is that the database values don’t match you filter. When that happens, instead first ask for the values in that category and then ask for the filtering as a follow-up question - when the bot sees the data first, it can construct much smarter filtering.
  4. Provide hints: If you get an unexpected or incomplete answer, ask again, and provide some additional information or context, or point out what was missing in the previous answer.
  5. Break very complex questions into few steps: If your question is very complex, ask it in steps and gradually make a journey through the data by adding context.

​
Support

If you have any questions or need help with the Honeydew Analyst App for Microsoft Teams, please reach out to support@honeydew.ai.