# Manage automations (/automations/manage)

<!-- agent-signals: reading_time_min: 8 · est_tokens: 3306 · updated: 2026-07-31 -->
Related: [Predefined automations](/automations/reference.md), [Integrations for the agent and automations](/automations/integrations.md), [Create a custom automation](/automations/create.md)

## Prerequisites [#prerequisites]

* A Mintlify project connected to a GitHub or GitLab repository
* For GitHub: the [Mintlify GitHub App](/deploy/github) installed on every repository you plan to use in the automation
* For GitLab: a connected GitLab account (see [GitLab setup](#gitlab-setup) below)

<Tip>
  You can also create, list, and delete automations from the terminal with [`mint workflow`](/cli/commands#mint-workflow). The CLI is useful for scripting and CI. The dashboard is the easiest way to configure and monitor automation runs.
</Tip>

## Enable an automation [#enable-an-automation]

1. Open the [Automations](https://app.mintlify.com/products/automations) page in your dashboard.
2. Click the toggle beside an automation to enable it.

   <Frame>
     <img src="/_assets/74d90cf5f87b84fd5b7b2022086d866a5b918949dfaa49b96df7ca1af346573f" alt="The automations dashboard." className="block dark:hidden" />

     <img src="/_assets/fcddd98f4c36849c167c1bce53cc3f240338f33c75b7822e14fc4dcb5da1701f" alt="The automations dashboard." className="hidden dark:block" />
   </Frame>

   If the automation can run with default settings, it activates immediately. Otherwise, the settings panel opens so you can fill in any required configurations.

   <Frame>
     <img src="/_assets/befd7701afa6b3962a0278a9dee2ea629bf7385769a9af2b1003c62600b05042" alt="The configuration options for an automation." className="block dark:hidden" />

     <img src="/_assets/da0caabe03a68d7a49118c1b8c65010fe8449472cf43e9fa705e6b8c8214f383" alt="The configuration options for an automation." className="hidden dark:block" />
   </Frame>
3. If the settings panel opens, fill in the required fields.
4. Click **Turn on automation**.

To change settings for an active automation, click the <Icon icon="<svg xmlns=&#x22;http://www.w3.org/2000/svg&#x22; viewBox=&#x22;0 0 24 24&#x22; fill=&#x22;none&#x22;><path d=&#x22;M21.3175 7.14139L20.8239 6.28479C20.4506 5.63696 20.264 5.31305 19.9464 5.18388C19.6288 5.05472 19.2696 5.15664 18.5513 5.36048L17.3311 5.70418C16.8725 5.80994 16.3913 5.74994 15.9726 5.53479L15.6357 5.34042C15.2766 5.11043 15.0004 4.77133 14.8475 4.37274L14.5136 3.37536C14.294 2.71534 14.1842 2.38533 13.9228 2.19657C13.6615 2.00781 13.3143 2.00781 12.6199 2.00781H11.5051C10.8108 2.00781 10.4636 2.00781 10.2022 2.19657C9.94085 2.38533 9.83106 2.71534 9.61149 3.37536L9.27753 4.37274C9.12465 4.77133 8.84845 5.11043 8.48937 5.34042L8.15249 5.53479C7.73374 5.74994 7.25259 5.80994 6.79398 5.70418L5.57375 5.36048C4.85541 5.15664 4.49625 5.05472 4.17867 5.18388C3.86109 5.31305 3.67445 5.63696 3.30115 6.28479L2.80757 7.14139C2.45766 7.74864 2.2827 8.05227 2.31666 8.37549C2.35061 8.69871 2.58483 8.95918 3.05326 9.48012L4.0843 10.6328C4.3363 10.9518 4.51521 11.5078 4.51521 12.0077C4.51521 12.5078 4.33636 13.0636 4.08433 13.3827L3.05326 14.5354C2.58483 15.0564 2.35062 15.3168 2.31666 15.6401C2.2827 15.9633 2.45766 16.2669 2.80757 16.8741L3.30114 17.7307C3.67443 18.3785 3.86109 18.7025 4.17867 18.8316C4.49625 18.9608 4.85542 18.8589 5.57377 18.655L6.79394 18.3113C7.25263 18.2055 7.73387 18.2656 8.15267 18.4808L8.4895 18.6752C8.84851 18.9052 9.12464 19.2442 9.2775 19.6428L9.61149 20.6403C9.83106 21.3003 9.94085 21.6303 10.2022 21.8191C10.4636 22.0078 10.8108 22.0078 11.5051 22.0078H12.6199C13.3143 22.0078 13.6615 22.0078 13.9228 21.8191C14.1842 21.6303 14.294 21.3003 14.5136 20.6403L14.8476 19.6428C15.0004 19.2442 15.2765 18.9052 15.6356 18.6752L15.9724 18.4808C16.3912 18.2656 16.8724 18.2055 17.3311 18.3113L18.5513 18.655C19.2696 18.8589 19.6288 18.9608 19.9464 18.8316C20.264 18.7025 20.4506 18.3785 20.8239 17.7307L21.3175 16.8741C21.6674 16.2669 21.8423 15.9633 21.8084 15.6401C21.7744 15.3168 21.5402 15.0564 21.0718 14.5354L20.0407 13.3827C19.7887 13.0636 19.6098 12.5078 19.6098 12.0077C19.6098 11.5078 19.7888 10.9518 20.0407 10.6328L21.0718 9.48012C21.5402 8.95918 21.7744 8.69871 21.8084 8.37549C21.8423 8.05227 21.6674 7.74864 21.3175 7.14139Z&#x22; stroke=&#x22;currentColor&#x22; stroke-linecap=&#x22;round&#x22; stroke-width=&#x22;1.5&#x22;/><path d=&#x22;M15.5195 12C15.5195 13.933 13.9525 15.5 12.0195 15.5C10.0865 15.5 8.51953 13.933 8.51953 12C8.51953 10.067 10.0865 8.5 12.0195 8.5C13.9525 8.5 15.5195 10.067 15.5195 12Z&#x22; stroke=&#x22;currentColor&#x22; stroke-width=&#x22;1.5&#x22;/></svg>" /> settings button beside it. Use the toggle in the modal header to enable or disable the automation without leaving the settings view.

## Configurations [#configurations]

### Trigger [#trigger]

Each automation has a default trigger that controls when it runs. To change the trigger, select a different option in the settings panel.

* **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.

### Update mode [#update-mode]

Each automation has a default mode for how it makes updates: either directly merging changes into your content repository, or opening a pull request for review.

To require a review before the automation updates your content, select **Require review** in the settings panel.

<Note>
  For GitHub repositories, automatic updates require the Mintlify GitHub App to have bypass permissions on every ruleset targeting your deploy branch, including organization-level and repository-level rulesets. See [Configure automerge](/guides/configure-automerge) for setup instructions.

  For GitLab repositories, automerge uses the GitLab OAuth connection and requires at least the Maintainer role on each project.
</Note>

### Context repositories [#context-repositories]

For custom automations and some predefined automations, you can add context repositories—additional source code repositories the agent reads when the automation runs. This is useful when your automation prompt references code, APIs, or other content that lives outside your project repository.

You can add up to 10 context repositories per automation. For each GitHub repository, install the Mintlify GitHub App. Add repositories on the [GitHub App settings](https://app.mintlify.com/settings/organization/github-app) page.

### Integrations [#integrations]

For custom automations and supported predefined automations, enable connected [integrations](/automations/integrations). The agent pulls context from shared tools like Notion, Jira, or Linear when the automation runs.

To enable integrations for an automation, open its settings and select the integrations you want to use in **Tools**.

If you select **Integration** as the trigger for a custom automation, the triggering integration is always a tool for that automation. See [Integrations](/automations/integrations) for connection scopes, supported events, and permissions.

### Slack notifications [#slack-notifications]

Send Slack messages to one or more channels when automations run.

To enable Slack notifications:

1. Install the [Mintlify Slack app](/agent/slack) in your workspace.
2. Click **Configure Slack** on the [Automations](https://app.mintlify.com/products/automations) page of your dashboard.
3. Select one or more channels to send notifications to.
4. Click **Save changes**.

Once enabled, Mintlify posts to the selected channels when:

* An automation opens a pull request for review.
* An automation pull request has been waiting for review for three days.
* An automation merges a pull request, or fails to complete.

### Instructions [#instructions]

Add optional instructions that append to the automation's base prompt on every run. Use these to adjust the style, tone, or other project-specific behaviors without changing the core automation logic.

### Target languages [#target-languages]

When you enable the **Translate content** automation, select one or more languages to keep in sync with your source content.

* Mintlify reads the [languages](/organize/navigation#languages) defined in your `docs.json` to identify your default language and preselects any already configured target languages.
* You must select at least one target language to save the automation.
* You cannot select the source language as a target.

You can add target languages at any time by opening the automation's settings and editing the **Translate to** field.

## GitLab setup [#gitlab-setup]

To use GitLab repositories in an automation, connect each project through the [GitLab OAuth](https://app.mintlify.com/settings/organization/gitlab-oauth) settings page. Connect every repository the automation touches—your documentation repository and any trigger or context repositories. You must have at least the Maintainer role on each project.

<Note>
  Automations require a paid GitLab tier. The agent uses short-lived project access tokens for repository access, which GitLab's Free plan does not support.
</Note>

## Disable an automation [#disable-an-automation]

1. Open the [Automations](https://app.mintlify.com/products/automations) page in your dashboard.
2. Click the toggle beside an automation to disable it.

When you re-enable a scheduled automation or change its schedule, Mintlify recalculates the next run time from the current time. Disabled automations do not retain a pending run time.

## Run an automation manually [#run-an-automation-manually]

You can trigger any enabled automation on demand without waiting for its next scheduled or event-based run.

1. Open the [Automations](https://app.mintlify.com/products/automations) page in your dashboard.
2. Click the <Icon icon="<svg xmlns=&#x22;http://www.w3.org/2000/svg&#x22; viewBox=&#x22;0 0 24 24&#x22; fill=&#x22;none&#x22;><path d=&#x22;M18.8906 12.846C18.5371 14.189 16.8667 15.138 13.5257 17.0361C10.296 18.8709 8.6812 19.7884 7.37983 19.4196C6.8418 19.2671 6.35159 18.9776 5.95624 18.5787C5 17.6139 5 15.7426 5 12C5 8.2574 5 6.3861 5.95624 5.42132C6.35159 5.02245 6.8418 4.73288 7.37983 4.58042C8.6812 4.21165 10.296 5.12907 13.5257 6.96393C16.8667 8.86197 18.5371 9.811 18.8906 11.154C19.0365 11.7084 19.0365 12.2916 18.8906 12.846Z&#x22; stroke=&#x22;currentColor&#x22; stroke-linejoin=&#x22;round&#x22; stroke-width=&#x22;1.5&#x22;/></svg>" /> run button beside the automation you want to start.

Manual runs use the automation's current configuration, count toward your credit usage, and appear in the run history alongside scheduled runs.

## Trigger a scheduled automation via API [#trigger-a-scheduled-automation-via-api]

For automations with a **Custom schedule** trigger, you can start a run from your own tooling instead of waiting for the next scheduled time. Use the [Trigger automation](/api/automations/trigger) endpoint to fire a run from a CI/CD pipeline, release script, or any service that can make an authenticated HTTP request.

API-triggered runs behave exactly like scheduled runs: they pick up everything that has changed since the last completed run, count toward credit usage, and appear in the run history.

## View run history [#view-run-history]

Each automation keeps a log of past runs, including the status and a summary of changes made.

1. Open the [Automations](https://app.mintlify.com/products/automations?tab=runs) page in your dashboard.
2. Use the dropdown menus to filter by specific automations or status.

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.
* **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.
* **Failed**: The agent could not complete the run. Failed runs do not count toward your daily run limit.
* **No action needed**: The agent finished the run but did not find anything to update.

Click an individual run to see its prompt, the files it read or changed, and any pull request it opened.

## Continue a run in the editor [#continue-a-run-in-the-editor]

After an automation completes and creates changes on a branch, you can open those changes directly in the editor to review, refine, or publish them.

1. Open the [Automations](https://app.mintlify.com/products/automations) page in your dashboard.
2. Click **View changes** beside the workflow run you want to continue working on in the editor.

The editor opens to the automation's branch with the agent panel already open. The agent panel shows each page the automation changed. Click any page to view changes made by the automation.

The editor agent has full context on what the automation did, including the automation's prompt, a summary of the changes, and which pages the automation modified. Ask the agent to refine or extend the work without re-explaining the background.