Slack Integration

The Slack integration sends a message to a Slack channel of your choice whenever a commit lands or a pull request is merged into your connected repository's tracked branch. This keeps your team informed the moment code moves — and serves as a prompt to check whether your documentation still reflects those changes.

Plan Requirements

The Slack integration is available on the Starter plan and above. It is listed under Standard integrations on the Starter plan, and is also included on Growth and Scale. The Free plan does not include it.

In addition to a paid plan, your docs site must be served from a custom sub-domain or sub-folder of your own domain. Analytics and integrations — including Slack — do not activate until a custom domain is connected, because there is nothing for Hyperdocs to announce until your docs are live at your own address. If your domain is not yet connected, a banner at the top of the Integrations page will prompt you to set it up before the Slack card can be used.

Prerequisites

Before connecting Slack, make sure the following are in place:

•A connected GitHub repository — Slack notifications are triggered by Git activity. If no repository is linked, the Slack card shows a warning and the connect button is disabled. Set up the Git integration first from Settings → App Integrations and then return to connect Slack.

•A custom domain connected — the integration requires your docs to be served from a sub-domain or sub-folder of your own domain. Connect one from Settings → Domain if you have not already.

•Admin role — only Admins can connect, change, or disconnect integrations. Editors and Viewers see the card but cannot interact with it.

How It Works

When the integration is connected, Hyperdocs uses a Slack OAuth flow to link a specific channel in your Slack workspace. After authorization, every commit push or pull request merge on your tracked branch triggers a message to that channel. The message tells your team that code moved — giving them a cue to review whether the documentation needs to catch up.

The connected channel name and Slack workspace name are displayed inside the card once the integration is active, so you can always see at a glance where notifications are going.

Connecting Slack

•Open your admin dashboard and go to Settings → App Integrations.

•Find the Slack card and click the header to expand it.

•Click Add Slack. Hyperdocs fetches a Slack OAuth URL and opens it in a new tab.

•In the Slack tab that opens, sign in to your Slack workspace if prompted, then pick the channel where you want notifications to appear and approve the connection.

•Return to the Hyperdocs tab. The card shows Waiting for Slack… while it polls for confirmation. Once Slack confirms the channel, the card updates automatically to show the connected channel name and workspace — no page refresh needed.

•If you need to cancel before the authorization completes, click Cancel in the waiting state to return the card to its disconnected state.

Changing the Slack Channel

You can switch the connected channel at any time without disconnecting and reconnecting from scratch.

•Open Settings → App Integrations and expand the Slack card.

•Click Change channel. Hyperdocs opens the Slack OAuth tab again.

•Select the new channel in Slack and approve the connection.

•Return to Hyperdocs. The card polls until it detects that the channel has changed, then updates the displayed channel name automatically.

Disconnecting Slack

Disconnecting removes the integration immediately. Hyperdocs will stop posting notifications to your Slack channel. You can reconnect at any time by following the connection steps above.

•Open Settings → App Integrations and expand the Slack card.

•Click Disconnect.

•Confirm the action in the dialog that appears. The card returns to its disconnected state and notifications stop immediately.

Connection States

The Slack card reflects the current state of the integration at all times:

•Loading — the card is checking the current Slack connection status on page load.

•Disconnected — no Slack channel is linked. The Add Slack button is shown.

•Waiting for Slack… — the OAuth tab has been opened and Hyperdocs is polling for the channel selection to complete.

•Connected — a channel is linked. The channel name (e.g. #docs-updates) and Slack workspace name are displayed, along with the Change channel and Disconnect buttons.

Plan Restriction Prompt

If your workspace is on the Free plan or does not yet have a custom domain connected, clicking Add Slack or Change channel opens an upgrade or domain-connection prompt instead of starting the OAuth flow. The buttons remain visible and clickable on all plans — the prompt explains what is needed to proceed. Upgrading your plan or connecting a domain resolves the restriction immediately.

Slack Integration

Plan Requirements

Prerequisites

Before connecting Slack, make sure the following are in place:

•Admin role — only Admins can connect, change, or disconnect integrations. Editors and Viewers see the card but cannot interact with it.

How It Works

The connected channel name and Slack workspace name are displayed inside the card once the integration is active, so you can always see at a glance where notifications are going.

Connecting Slack

•Open your admin dashboard and go to Settings → App Integrations.

•Find the Slack card and click the header to expand it.

•Click Add Slack. Hyperdocs fetches a Slack OAuth URL and opens it in a new tab.

•In the Slack tab that opens, sign in to your Slack workspace if prompted, then pick the channel where you want notifications to appear and approve the connection.

•If you need to cancel before the authorization completes, click Cancel in the waiting state to return the card to its disconnected state.

Changing the Slack Channel

You can switch the connected channel at any time without disconnecting and reconnecting from scratch.

•Open Settings → App Integrations and expand the Slack card.

•Click Change channel. Hyperdocs opens the Slack OAuth tab again.

•Select the new channel in Slack and approve the connection.

•Return to Hyperdocs. The card polls until it detects that the channel has changed, then updates the displayed channel name automatically.

Disconnecting Slack

Disconnecting removes the integration immediately. Hyperdocs will stop posting notifications to your Slack channel. You can reconnect at any time by following the connection steps above.

•Open Settings → App Integrations and expand the Slack card.

•Click Disconnect.

•Confirm the action in the dialog that appears. The card returns to its disconnected state and notifications stop immediately.

Connection States

The Slack card reflects the current state of the integration at all times:

•Loading — the card is checking the current Slack connection status on page load.

•Disconnected — no Slack channel is linked. The Add Slack button is shown.

•Waiting for Slack… — the OAuth tab has been opened and Hyperdocs is polling for the channel selection to complete.

•Connected — a channel is linked. The channel name (e.g. #docs-updates) and Slack workspace name are displayed, along with the Change channel and Disconnect buttons.