-
Notifications
You must be signed in to change notification settings - Fork 60
W-23599998-teams-integration-fa #522
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
failup
wants to merge
6
commits into
latest
Choose a base branch
from
W-23599998-teams-integration-fa
base: latest
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
0f9fcb3
Create exp-teams-integrate.adoc
failup 00e021b
W-23599998-teams-integration-fa
failup ca2b923
Update nav.adoc
failup ef13142
W-23907421-teams-GA-fa
failup a54e67a
Update exp-teams-integrate.adoc
failup dbb4f89
Merge pull request #547 from mulesoft/W-23907421-teams-GA-fa
failup File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,184 @@ | ||
| = Integrate the Enhanced Experience with Microsoft Teams | ||
| :keywords: microsoft teams integration, mulesoft agent, teams bot, mcp server, anypoint platform, enhanced experience | ||
|
|
||
| NOTE: This feature is in early access. | ||
|
|
||
| Install the MuleSoft for Teams app in your Microsoft Teams tenant to interact with MuleSoft directly from Teams using natural language. The Teams app enables you to: | ||
|
|
||
| * <<connect-teams-tenant>>: Bind your Microsoft Teams tenant to your Anypoint organization so the app can send alerts and notifications directly to channels and DMs. | ||
| * <<begin-using-agent>>: Manage your MuleSoft environment with the MuleSoft Agent integrated with Teams. Use MuleSoft Agent to list APIs, view MCP servers, check governance, and perform other management tasks. | ||
|
failup marked this conversation as resolved.
|
||
| * Configure alerts to deliver notifications to Teams channels. For instructions, see xref:exp-alerts-configure-notifications.adoc[]. | ||
|
failup marked this conversation as resolved.
|
||
|
|
||
| NOTE: This tool uses generative AI, which can produce inaccurate or harmful responses. Review for accuracy and safety before using. | ||
|
|
||
| [[before-you-begin]] | ||
| == Before You Begin | ||
|
|
||
| Before setting up the Teams integration, verify that the following requirements are met: | ||
|
|
||
| * *Agentforce Enabled*: Agentforce must be enabled within your Anypoint Platform organization. | ||
| * *Salesforce-Anypoint Connection*: Your Anypoint Platform organization must be fully connected to your Salesforce organization. | ||
| * *Early Access Program*: The MuleSoft Agent feature must be enabled for your organization by the MuleSoft team as part of the Early Access Program. Contact your Customer Success Manager (CSM) or Account Executive (AE) to join the program. | ||
|
|
||
| [[connect-teams-tenant]] | ||
| == Connect Your Microsoft Teams Tenant to the MuleSoft Organization | ||
|
|
||
| You must be a MuleSoft organization administrator and a Microsoft Teams administrator to connect the Teams integration. If you are not a Teams administrator, you can send a request to your Teams administrator to approve the app. | ||
|
|
||
| Each MuleSoft organization can connect to only one Microsoft Teams tenant, and each tenant can connect to only one MuleSoft organization. | ||
|
|
||
| . Log in and go to *Notifications* > *Settings*. | ||
| . In *Microsoft Teams Setup*, click *Install Microsoft Teams app*. This publishes the Teams app to your AAD tenant's app catalog through Microsoft Graph. If the tenant hasn't yet consented to this app, you're redirected to Microsoft to grant admin consent. | ||
| . Select your Microsoft Teams admin account. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Did this information come from engineering?
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I got it from the demo video. If this changed i'd love to see the new path! |
||
| . Review the permissions requested and click *Accept*. | ||
| + | ||
| The app requests the following permissions: | ||
| + | ||
| * Read and write to all app catalogs | ||
| * Maintain access to data you have given it access to | ||
| * View your basic profile | ||
| + | ||
| . After the installation completes, the confirmation page displays *Microsoft Teams integration installed*. Click *Back to Settings*. | ||
| + | ||
| In *Notifications* > *Settings*, the *Microsoft Teams Setup* section now shows *Installed* and displays the bound tenant ID. | ||
| . Click *Grant Access* to allow the app to browse your Teams directory for channel and team member access. | ||
| . In Microsoft Teams, review the permissions requested and click *Accept*. | ||
| + | ||
| After access is granted, configure notification channels in the *Notification Channels* section. | ||
|
|
||
| After installation, the MuleSoft Agent app appears in Microsoft Teams Admin Center under *Manage apps* as available to everyone and unblocked. | ||
|
|
||
| To disconnect the integration: | ||
|
|
||
| . Click *Disconnect* in the *Microsoft Teams Setup* section. | ||
| . Confirm the disconnection. This immediately revokes MuleSoft's access to your Teams tenant and stops all notifications. | ||
| + | ||
| The MuleSoft app remains in the Microsoft Teams Admin Center. To fully remove it, a Teams administrator must uninstall it from the Admin Center, or right-click the app in Teams and select *Uninstall*. | ||
|
|
||
| [[begin-using-agent]] | ||
| == Begin Using the MuleSoft Agent | ||
|
|
||
| [IMPORTANT] | ||
| ==== | ||
| MuleSoft Agent is available on request. To get access, contact your account executive. | ||
| ==== | ||
|
|
||
| Before getting started, make sure you have: | ||
|
|
||
| * An Anypoint Platform account with access to the enhanced experience. | ||
| * Agentforce enabled in your Anypoint Platform and Salesforce organizations by your administrator. | ||
| * The *MuleSoft Agent AI User* permission assigned to your user. | ||
| + | ||
| For more information, see xref:exp-home-start.adoc#permissions[Enhanced Experience Permissions]. | ||
|
|
||
| To assign the *MuleSoft Agent AI User* permission across business groups: | ||
|
|
||
| . Log in to Anypoint Platform and open *Access Management*. | ||
| . Select the business group where you want to assign the permission. | ||
| . Find the user and assign the *MuleSoft Agent AI User* permission. | ||
| . Repeat for each business group that requires access. | ||
|
|
||
| To start using the agent in Teams: | ||
|
|
||
| . Open Microsoft Teams and go to *Apps*. | ||
| . Under *Built for your organisation*, find *MuleSoft Agent* and click *Add*. | ||
| . Click *Open* or select a channel where you want to use the app. | ||
| . The agent sends a welcome message. Select a prompt suggestion or type a message to start. | ||
| . If prompted, click *Connect to MuleSoft* and sign in with your Anypoint Platform credentials. | ||
| . After authenticating, close the browser tab to complete account linking. Return to Teams to continue the conversation. | ||
|
|
||
| After you authenticate, you can use the agent to list APIs, agents, MCP servers, view governance reports, and more. | ||
|
|
||
| NOTE: After the first 24 hours, you must @mention the MuleSoft Agent in channels to send it a message. In direct messages, you can send messages to the agent at any time without @mentioning it. | ||
|
|
||
| [[available-prompts]] | ||
| == Available Prompt Suggestions | ||
|
|
||
| When you open the MuleSoft Agent, the following prompt suggestions are available: | ||
|
|
||
| * *signin*: Connect your MuleSoft account. | ||
| * *signout*: Disconnect your MuleSoft account. | ||
| * *What business group am I in?*: Shows your current business group. | ||
| * *List APIs in my business group*: Lists APIs in your current business group. | ||
| * *Risks across my portfolio?*: Shows risks across your portfolio. | ||
| * *Top MCP token spend this week*: Shows which MCP servers had the highest token spend this week. | ||
| * *Which agents have instances?*: Lists agents that have instances. | ||
| * *Top API error rates (7 days)*: Shows APIs with the highest error rates over the past 7 days. | ||
| * *feedback*: Send feedback to the MuleSoft Agent team. | ||
| * *help*: Show available commands. | ||
|
|
||
| [[common-use-cases]] | ||
| == Common Use Cases for the MuleSoft Agent | ||
|
|
||
| You can use the MuleSoft Agent to perform these platform tasks in Teams: | ||
|
|
||
| * *Receive alerts*: Receive alerts to channels. For more information, see xref:exp-alerts-configure-notifications.adoc[]. | ||
| * *Find services by capability*: Use natural-language search to discover APIs, agents, LLMs, and MCP servers. | ||
| * *Run governance, monitoring, and cost drill-ins*: Generate governance, monitoring, and cost reports on request. | ||
| * *Take governance actions*: Apply policies and apply cost management recommendations. | ||
|
|
||
| [[microsoft-graph-permissions]] | ||
| == Microsoft Graph Permissions | ||
|
|
||
| The MuleSoft for Microsoft Teams app requires the following Microsoft Graph permissions. Use this information when your security or IT team asks for justification before approving the app installation. | ||
|
|
||
| [cols="2,1,3", options="header"] | ||
| |=== | ||
| |Permission |Type |Purpose | ||
|
|
||
| |`AppCatalog.Read.All` | ||
| |Application | ||
| |Verifies that the MuleSoft app is properly published in your Teams app catalog. Without this, the app cannot confirm its own availability, and users see silent failures instead of actionable setup errors. | ||
|
|
||
| |`AppCatalog.ReadWrite.All` | ||
| |Delegated | ||
| |Required when a Teams admin publishes or updates the MuleSoft app package in your catalog. Only exercised during install or upgrade — not at runtime — and scoped to the consenting admin's session. | ||
|
|
||
| |`AppCatalog.ReadWrite.All` | ||
| |Application | ||
| |Allows the MuleSoft app to receive updates, such as new Adaptive Card formats or capability additions, without requiring an admin to manually republish each time. | ||
|
|
||
| |`Channel.ReadBasic.All` | ||
| |Application | ||
| |Delivers API alerts and deployment notifications to specific channels you configure. The app reads channel names and IDs to resolve routing rules. It reads channel metadata only — not message content. | ||
|
|
||
| |`Team.ReadBasic.All` | ||
| |Application | ||
| |During setup, lets you map MuleSoft environments and business groups to specific teams without manually looking up team IDs. Read-only access to team names and descriptions — no access to members or content. | ||
|
|
||
| |`TeamsAppInstallation.ReadWriteAndConsentForTeam.All` | ||
| |Application | ||
| |Lets a Teams admin roll the app out to all relevant teams in a single action with automatic RSC consent, rather than requiring each individual team owner to install it separately. | ||
|
|
||
| |`TeamsAppInstallation.ReadWriteForTeam.All` | ||
| |Application | ||
| |Manages the app lifecycle across teams, including handling version upgrades and removing the app from teams where it is no longer needed. | ||
|
|
||
| |`TeamSettings.Read.All` | ||
| |Application | ||
| |Checks team policies before the app attempts to post. If a team has restricted messaging or moderation enabled, the app surfaces a clear configuration error rather than silently dropping critical API alerts. Read-only — it does not change settings through this permission. | ||
|
|
||
| |`TeamSettings.ReadWrite.All` | ||
| |Application | ||
| |During initial provisioning only, the app may adjust channel settings to enable bot posting in moderated channels where incident alerts must be delivered. This is a one-time setup action, not ongoing runtime behavior. | ||
|
|
||
| |`User.Read` | ||
| |Delegated | ||
| |Standard sign-in permission for the admin performing the initial consent. The app reads basic profile information (name, email) to log who authorized the connection between the Anypoint Platform organization and the Teams tenant. | ||
|
|
||
| |=== | ||
|
|
||
| [[security-data-compliance]] | ||
| == Security, Data Retention, and Residency | ||
|
|
||
| * *Hyperforce and data boundaries*: The MuleSoft Agent respects your designated Hyperforce region. Install the regional app for Teams that corresponds to your region. Customer data never leaves your designated Hyperforce boundary. | ||
| * *LLM architecture and web access*: The MuleSoft Agent uses the Salesforce LLM-Gateway, powered by OpenAI GPT-5-mini. The agent does not perform public web searches. | ||
| * *Data retention and compliance*: Data retention policies, data removal, LLM data tenancy, and infrastructure details are covered in the applicable Salesforce Security, Privacy, and Architecture (SPARC) documentation. Customer data is securely deleted upon expiration of the applicable retention periods in accordance with SPARC guidelines. For more information, see the https://www.salesforce.com/company/legal/trust-and-compliance-documentation/[Salesforce Trust and Compliance Documentation]. | ||
|
|
||
| [[see-also]] | ||
| == See Also | ||
|
|
||
| * xref:exp-home-start.adoc[] | ||
| * xref:exp-overview.adoc[] | ||
| * xref:exp-slack-integrate.adoc[] | ||
| * xref:exp-claude-desktop-connect.adoc[] | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.