Skip to main content

Documentation Index

Fetch the complete documentation index at: https://help-center-starter-replace-template-content.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Connect Mintlify to Slack to receive notifications about deployments, failed builds, and other project activity directly in your channels.

Set up Slack notifications

Mintlify can send deployment status updates to Slack via a webhook. The most common setup routes these through GitHub or GitLab Actions.

Using GitHub Actions

Add a Slack notification step to your CI workflow that fires after Mintlify deploys:
- name: Notify Slack on deploy
  uses: slackapi/slack-github-action@v1
  with:
    payload: |
      {
        "text": "Docs deployed: ${{ github.event.head_commit.message }}"
      }
  env:
    SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
Store your Slack webhook URL as a GitHub Actions secret (SLACK_WEBHOOK_URL) — never hardcode it in the workflow file.

Channel strategy

  • Use a dedicated #docs-deploys channel for deployment notifications — this keeps the signal separate from other engineering noise.
  • Reserve @channel mentions for failed builds or broken links, not routine deploys.

Troubleshooting

If notifications stop:
  • Confirm the webhook URL is still valid — Slack deactivates webhook URLs when a workspace app is removed.
  • Check whether the bot was removed from the target channel.
  • Re-create the webhook in Slack → Apps → Incoming Webhooks if needed.