Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions automations/index.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Automations overview"
sidebarTitle: "Overview"
description: "Automate content maintenance with Mintlify automations by running the agent on a schedule, on repository pushes, or on connected integration events."
description: "Automate content maintenance with Mintlify automations by running the agent on a schedule, on repository pushes, on Slack messages, or on connected third-party integration events."
keywords: ["automation", "automate", "cron", "agent", "automations"]
boost: 5
---
Expand All @@ -10,7 +10,7 @@
Automations require a [Pro or Enterprise plan](https://mintlify.com/pricing?ref=automations).
</Info>

Automations run the agent automatically on a schedule, in response to pushes to a repository, or when an event occurs in a connected integration. Each automation defines a prompt for the agent and a trigger for when to run it. Automations support both GitHub and GitLab repositories with the same triggers, predefined automations, and update modes. Throughout this guide, "pull request" also refers to GitLab merge requests unless noted otherwise.
Automations run the agent automatically on a schedule, in response to pushes to a repository, when a message is posted in selected Slack channels, or when an event occurs in a connected third-party integration. Each automation defines a prompt for the agent and a trigger for when to run it. Automations support both GitHub and GitLab repositories with the same triggers, predefined automations, and update modes. Throughout this guide, "pull request" also refers to GitLab merge requests unless noted otherwise.

Check warning on line 13 in automations/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

automations/index.mdx#L13

In general, use active voice instead of passive voice ('is posted').

When an automation runs, the agent reads your project content and any connected repositories, then follows the prompt to make updates.

Expand All @@ -27,7 +27,9 @@
- **Content update**: Runs when content changes push to your Mintlify project repository, including pull request merges and direct pushes.
- **Code change**: Runs when a pull request merges in a connected source code repository.
- **Custom schedule**: Runs on a recurring schedule. Automations queue within 10 minutes of the scheduled time.
- **Integration**: Runs when a selected event occurs in a connected shared integration. Requires an [Enterprise plan](https://mintlify.com/pricing?ref=automations).
- **Integration**: Runs when a selected event occurs in a connected third-party integration or when a new top-level message is posted in a Slack channel you select for a custom automation. For Slack messages, the agent decides whether the message warrants action. Requires an [Enterprise plan](https://mintlify.com/pricing?ref=automations).

Check warning on line 30 in automations/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

automations/index.mdx#L30

In general, use active voice instead of passive voice ('is posted').

Slack message triggers use the [Mintlify Slack app](/agent/slack). They are configured through the **Integration** trigger, but they do not use a third-party integration connected from the **Integrations** settings page.

Check warning on line 32 in automations/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

automations/index.mdx#L32

In general, use active voice instead of passive voice ('are configured').

Each automation has exactly one trigger. You cannot combine trigger types in a single automation.

Expand Down
26 changes: 20 additions & 6 deletions automations/integrations.mdx
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
---
title: "Integrations for the agent and automations"
sidebarTitle: "Integrations"
description: "Connect third-party apps so the Mintlify agent can use live context in Slack, during automation runs, or as a trigger for custom automations."
description: "Connect third-party apps for live context in Slack and automation runs, or use the Mintlify Slack app as a trigger for custom automations."
keywords: ["integrations", "Slack agent", "Notion", "Linear", "Jira", "LaunchDarkly", "Confluence", "Salesforce", "Salesforce Service Cloud", "PostHog", "Intercom", "Google Drive", "OneDrive", "Gmail", "Outlook", "HubSpot", "Plain", "Pylon", "Stripe", "automation trigger", "context"]
---

Integrations connect the Mintlify agent to other tools your team uses. The agent can use connected apps while responding in Slack or running an automation. Events from some shared integrations can also start a custom automation.
Integrations connect the Mintlify agent to other tools your team uses. The agent can use connected apps while responding in Slack or running an automation. Events from some shared integrations and messages in selected Slack channels can also start a custom automation.

| Integration use | What it does |
| --- | --- |
| **Slack agent** | Uses shared integrations and the personal integrations of the teammate who is chatting with the agent as context. |
| **Automation tool** | Gives an automation read-only context from the shared integrations selected in its **Tools** setting. |
| **Automation trigger** | Starts a custom automation when a selected event occurs in a supported shared integration. |
| **Automation trigger** | Starts a custom automation when a selected event occurs in a supported shared integration or when the agent determines that a message in a selected Slack channel warrants action. |

<Note>
The [Mintlify Slack app](/agent/slack) is separate from the integrations on this page. Installing the Slack app adds the agent to your workspace and gives the agent and automation runs access to Slack content that the app can read. You do not connect Slack from the **Integrations** settings page or select it in an automation's **Tools** field.
Expand Down Expand Up @@ -97,11 +97,13 @@ Automation tools give the agent additional context after an automation starts. Y
3. Connect any selected integration that is not already connected.
4. Save the automation.

If an integration is an automation trigger, it is always a tool for that automation. This lets the agent retrieve additional details after it receives the event that started the run.
If a third-party integration is an automation trigger, it is always a tool for that automation. This lets the agent retrieve additional details after it receives the event that started the run.

## Trigger an automation from an integration

Custom automations can run when an event occurs in a supported shared integration.
Custom automations can run when an event occurs in a supported shared integration. They can also use the installed [Mintlify Slack app](/agent/slack) as a trigger for messages in selected channels.

### Third-party integration events

1. Create or open a custom automation.
2. For **Trigger**, select **Integration**.
Expand All @@ -110,7 +112,7 @@ Custom automations can run when an event occurs in a supported shared integratio
5. Complete any additional event fields that appear.
6. Save and turn on the automation.

The supported events depend on the integration:
The supported events for connected third-party integrations depend on the integration:

| Integration | Events |
| --- | --- |
Expand All @@ -123,6 +125,18 @@ The supported events depend on the integration:

When the event occurs, Mintlify starts the automation and includes the event payload as context for the agent. Duplicate deliveries of the same event do not start duplicate runs.

### Slack message triggers

1. Create or open a custom automation.
2. For **Trigger**, select **Integration**.
3. Select **Slack**.
4. Select the specific channels to listen to.
5. Save and turn on the automation.

Mintlify listens only to top-level channel messages in the selected channels, not replies in threads. When a top-level message arrives, the agent decides whether the message warrants action. If it does not, the run finishes without making changes.

Slack message triggers use the installed Mintlify Slack app. Slack is not connected from **Integrations** settings or selected as an automation tool.

## Permissions and access

The agent has read-only access through third-party integration tools. It can search and retrieve content, but it cannot use these tools to create, edit, or delete data in the connected app.
Expand Down
4 changes: 2 additions & 2 deletions automations/manage.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Manage automations"
description: "Enable, disable, trigger, and delete automations from your dashboard. Configure repository, schedule, and integration triggers; context repos; and automerge."
description: "Enable, disable, trigger, and delete automations from your dashboard. Configure repository, schedule, Slack message, and integration triggers; context repos; and automerge."
keywords: ["cron", "push", "automerge", "context", "automation instructions", "trigger", "disable automation", "enable automation"]
---

Expand Down Expand Up @@ -44,7 +44,7 @@
- **Content update**: Runs whenever you push content to your project repository, including pull request merges and direct pushes.
- **Code change**: Runs when a pull request merges in a connected source code repository. You must specify at least one source repository.
- **Custom schedule**: Runs on a recurring schedule you define. Automations queue within 10 minutes of the scheduled time.
- **Integration**: Runs when a selected event occurs in a connected shared integration. Available for custom automations. Select the integration and event, then complete any additional event fields that appear.
- **Integration**: Runs when a selected event occurs in a connected third-party integration or when a new top-level message is posted in a Slack channel you select. Available for custom automations. For third-party integrations, select the integration and event, then complete any additional event fields that appear. For Slack, select Slack and one or more channels. Replies in threads do not trigger runs. For each Slack message, the agent decides whether it warrants action. If it does not, the run finishes without making changes.

Check warning on line 47 in automations/manage.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

automations/manage.mdx#L47

In general, use active voice instead of passive voice ('is posted').

### Update mode

Expand Down Expand Up @@ -135,7 +135,7 @@

Each run shows one of the following statuses:

- **Review needed**: The agent finished the run, but the changes must be reviewed and merged by someone on your team.

Check warning on line 138 in automations/manage.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

automations/manage.mdx#L138

In general, use active voice instead of passive voice ('be reviewed').
- **Running**: The agent is actively working on the automation job.
- **Accepted**: The agent finished the run and the changes merged into your repository.
- **Closed**: The agent finished the run, but someone rejected the changes.
Expand Down