diff --git a/agent/slack.mdx b/agent/slack.mdx index b9cb28b68..3c01f0ec2 100644 --- a/agent/slack.mdx +++ b/agent/slack.mdx @@ -19,33 +19,34 @@ The Slack agent runs on [Autopilot](/autopilot). When Autopilot posts in a Slack ## Connect your Slack workspace + The Slack agent is not available for [Bitbucket Cloud](/deploy/bitbucket) projects. + If your Slack Workspace Owner requires admin approval to install apps, ask them to approve the Mintlify app before you connect it. Each Slack workspace can connect to only one Mintlify organization at a time. If you try to install the agent into a workspace that is already connected to a different organization, the installation fails with a "wrong organization" error. Uninstall the app from the other organization first, or use a different Slack workspace. You can install the Slack agent even if you don't have a Mintlify-hosted project. The agent still works for question answering and conversations. Features that open pull requests require a connected repository. + + If your Git provider is behind an IP allowlist, allow the Mintlify egress IP `54.242.90.151` so the agent can clone your repository. Contact support to opt in. 1. Open your [Automations](https://app.mintlify.com/settings/project/automations) settings. 2. Click **Connect Slack**. 3. Follow the Slack prompts to install the `mintlify` app in your workspace and grant the requested permissions. -4. Confirm the connection in your Mintlify dashboard to your Slack workspace. -5. Test that the agent is working and responds when you: +4. Test that the agent responds when you: - Send it a message in its **Chat** tab. - Mention the agent with `@mintlify` in a channel. + + On Enterprise plans, you can start from the [Integrations](https://app.mintlify.com/settings/organization/integrations) page in your dashboard settings instead. Click **Connect** next to Slack, then continue from step 3. + + On Slack Enterprise Grid, you must install the app to the specific workspace where you want to use the agent. If you skip this step, the agent appears available at the organization level but does not respond in your workspace. To add the app to a workspace, open your organization's app management page (a URL like `https://app.slack.com/manage//integrations/installed`). Find the `mintlify` app and install it to your workspace. - - The Slack agent is not available for [Bitbucket Cloud](/deploy/bitbucket) projects. - - If your Git provider is behind an IP allowlist, allow the Mintlify egress IP `54.242.90.151` so the agent can clone your repository. Contact support to opt in. - - ### Disconnect the agent To remove the agent from your Slack workspace: @@ -56,6 +57,10 @@ To remove the agent from your Slack workspace: 4. In Slack, navigate to **Manage apps**. 5. Click **Remove** on the Mintlify app. + + On Enterprise plans, you can start from the [Integrations](https://app.mintlify.com/settings/organization/integrations) page instead. Click **Configure** next to Slack, click **Disconnect** and confirm, then continue from step 4. + + When you disconnect the Slack app, the agent stops responding to mentions and direct messages, and automations that post to Slack stop delivering notifications. ### Reconnect or reinstall the agent diff --git a/automations/integrations.mdx b/automations/integrations.mdx index a2cab1116..3440e3035 100644 --- a/automations/integrations.mdx +++ b/automations/integrations.mdx @@ -18,7 +18,7 @@ Integrations connect the Mintlify agent to other tools your team uses. The agent | **Automation trigger** | Starts a custom automation when a selected event occurs in a supported shared integration or when a new message posts to a selected Slack channel. | - The [Mintlify Slack app](/agent/slack) is separate from the third-party integrations on this page. Installing the Slack app adds the agent to your workspace and gives it read access to Slack content. You do not connect Slack from the **Integrations** settings page or select it in an automation's **Integrations** field. After you install the Slack app, you can select Slack as a custom automation trigger and the [editor agent](/editor/agent#read-your-slack-workspace) can read your workspace for context. + The [Mintlify Slack app](/agent/slack) works differently from the third-party integrations on this page. Installing the Slack app adds the agent to your workspace and gives it read access to Slack content. You can install it from the **Integrations** settings page, but you cannot select Slack in an automation's **Integrations** field. After you install the Slack app, you can select Slack as a custom automation trigger and the [editor agent](/editor/agent#read-your-slack-workspace) can read your workspace for context. ## Connection scope @@ -157,6 +157,8 @@ Disconnecting a shared integration removes it for everyone in your organization. Disconnecting a personal integration only removes your connection. Other teammates keep their personal connections. +To disconnect Slack, see [Disconnect the agent](/agent/slack#disconnect-the-agent). + ## Troubleshoot a connection If an integration stops working: diff --git a/mint-instructions/automate.mdx b/mint-instructions/automate.mdx index 6f90375c8..fd9b2a7e8 100644 --- a/mint-instructions/automate.mdx +++ b/mint-instructions/automate.mdx @@ -24,7 +24,7 @@ Use this to keep docs current or check them on every pull request. Most setup is 5. Automations: the user creates and manages them on the **Automations** page of the dashboard. Help them choose a name, trigger, and prompt. Prompts: one task, numbered steps, exact paths, done state. 6. Test: user clicks **Test run** / **Run now** and picks a scope (**Since a date**, **Everything**, **Specific pull request**). Not available for Integration or Webhook triggers. Check the **Runs** tab. 7. Autopilot: user opens https://app.mintlify.com/products/autopilot, switches on the toggle, picks **Additional repositories** under GitHub **Configure** (GitLab: **Additional projects**, after connecting projects through GitLab OAuth in Git settings. Azure Repos: **Configure** in the **Azure Repos** row), and uses **Chat to configure** to change reviewers, target branch, or schedule. -8. Slack agent: user clicks **Connect Slack** on the Automations page and installs the `mintlify` app (workspace admin approval may be needed; on Enterprise Grid install to the specific workspace). Test with a DM or `@mintlify` in a channel. The Slack agent also chats with Autopilot: ask about its work or change what it works on. Not available for Bitbucket Cloud projects. +8. Slack agent: user clicks **Connect Slack** on the Automations page (on Enterprise, they can instead click **Connect** next to Slack on the organization **Integrations** settings page) and installs the `mintlify` app (workspace admin approval may be needed; on Enterprise Grid install to the specific workspace). Test with a DM or `@mintlify` in a channel. The Slack agent also chats with Autopilot: ask about its work or change what it works on. Not available for Bitbucket Cloud projects. ## What each piece does