## Summary **Batch A of Phase 3** of the H1 → front-matter migration (`DOCS-484`; parent `DOCS-477`). Adds a front-matter `title` to every navigable docs page whose title can be migrated **mechanically**, with no editorial judgment. This is the content step that Phase 1 (renderers prefer front-matter title, `DOCS-482`) and Phase 2 (tooling + generators front-matter-aware, `DOCS-483`) unblocked. Both are merged; coder.com #964/#974 are merged and live. **Rendered no-op.** The renderers already resolve the page title from the manifest and hide the leading body H1 (Phase 1), so no page changes visually. This just moves the title into front matter where Fumadocs and the migrated tooling can read it. ## What's in this batch Dry-run on `main` (464 navigable pages) splits into: | category | count | this PR | |----------|-------|---------| | already has front-matter title (Reference, from Phase 2 generators) | 196 | skipped (idempotent) | | **mechanical** — leading body H1 equals the manifest label | 138 | ✅ add front-matter `title`, drop the duplicate H1 | | **no body H1** — renders under the manifest label only | 4 | ✅ add front-matter `title` only | | **mismatch** — body H1 differs from the manifest label | 126 | ⏭️ deferred (needs an editorial decision, see below) | 142 files changed, all under `docs/`. ## Deliberately out of scope: the 126 mismatches Pages where the body H1 is richer than the short sidebar label (e.g. label **Modules** / H1 *Contributing modules*, label **Install** / H1 *Installing Coder*) need a canonical-title decision, not a script. A few even look like the body H1 is the redundant one (`install/cli.md` and `install/index.md` both carry the H1 *Installing Coder*). These will land in follow-up batches **by nav section** once the policy is set, so each gets real review. ## Verification AI was the primary author of this PR (see disclosure below); per the [AI Contribution Guidelines](https://coder.com/docs/about/contributing/AI_CONTRIBUTING) here is the manual verification. - Every added front-matter block parses as YAML and its `title` round-trips to the manifest label (checked programmatically across all 142 files). - Every removed line is a leading `# H1` that equalled the manifest title; no body prose was reflowed. Front matter is correctly hoisted above pre-existing `<!-- markdownlint-disable -->` comments on the two pages that had them. - `pnpm check-docs` (markdownlint-cli2 + table formatter) passes on the changed set: `Summary: 0 error(s)`. `MD041` stays off (re-enabled in Phase 4); `MD025` is not tripped because the duplicate body H1s are removed. ``` $ pnpm exec markdownlint-cli2 $(git diff --name-only origin/main) Linting: 142 file(s) Summary: 0 error(s) ``` Linear: DOCS-484 > This PR was created with AI assistance (Coder Agents).
6.3 KiB
title
| title |
|---|
| Slack Notifications |
Slack is a popular messaging platform designed for teams and businesses, enabling real-time collaboration through channels, direct messages, and integrations with external tools. With Coder's integration, you can enable automated notifications directly within a self-hosted Slack app, keeping your team updated on key events in your Coder environment.
Administrators can configure Coder to send notifications via an incoming webhook endpoint. These notifications will be delivered as Slack messages direct to the user. Routing is based on the user's email address, and this should be consistent between Slack and their Coder login.
Requirements
Before setting up Slack notifications, ensure that you have the following:
- Administrator access to the Slack platform to create apps
- Coder platform >=v2.16.0
Create Slack Application
To integrate Slack with Coder, follow these steps to create a Slack application:
-
Go to the Slack Apps dashboard and create a new Slack App.
-
Under "Basic Information," you'll find a "Signing Secret." The Slack application uses it to verify requests coming from Slack.
-
Under "OAuth & Permissions", add the following OAuth scopes:
chat:write: To send messages as the app.users:read: To find the user details.users:read.email: To find user emails.
-
Install the app to your workspace and note down the Bot User OAuth Token from the "OAuth & Permissions" section.
Build a Webserver to Receive Webhooks
The Slack bot for Coder runs as a Bolt application, which is a framework designed for building Slack apps using the Slack API. Bolt for JavaScript provides an easy-to-use API for responding to events, commands, and interactions from Slack.
To build the server to receive webhooks and interact with Slack:
-
Initialize your project by running:
npm init -y -
Install the Bolt library:
npm install @slack/bolt -
Create and edit the
app.jsfile. Below is an example of the basic structure:const { App, LogLevel, ExpressReceiver } = require("@slack/bolt"); const bodyParser = require("body-parser"); const port = process.env.PORT || 6000; // Create a Bolt Receiver const receiver = new ExpressReceiver({ signingSecret: process.env.SLACK_SIGNING_SECRET, }); receiver.router.use(bodyParser.json()); // Create the Bolt App, using the receiver const app = new App({ token: process.env.SLACK_BOT_TOKEN, logLevel: LogLevel.DEBUG, receiver, }); receiver.router.post("/v1/webhook", async (req, res) => { try { if (!req.body) { return res.status(400).send("Error: request body is missing"); } const { title, body_markdown } = req.body; if (!title || !body_markdown) { return res .status(400) .send('Error: missing fields: "title", or "body_markdown"'); } const payload = req.body.payload; if (!payload) { return res.status(400).send('Error: missing "payload" field'); } const { user_email, actions } = payload; if (!user_email || !actions) { return res .status(400) .send('Error: missing fields: "user_email", "actions"'); } // Get the user ID using Slack API const userByEmail = await app.client.users.lookupByEmail({ email: user_email, }); const slackMessage = { channel: userByEmail.user.id, text: body_markdown, blocks: [ { type: "header", text: { type: "plain_text", text: title }, }, { type: "section", text: { type: "mrkdwn", text: body_markdown }, }, ], }; // Add action buttons if they exist if (actions && actions.length > 0) { slackMessage.blocks.push({ type: "actions", elements: actions.map((action) => ({ type: "button", text: { type: "plain_text", text: action.label }, url: action.url, })), }); } // Post message to the user on Slack await app.client.chat.postMessage(slackMessage); res.status(204).send(); } catch (error) { console.error("Error sending message:", error); res.status(500).send(); } }); // Acknowledge clicks on link_button, otherwise Slack UI // complains about missing events. app.action("button_click", async ({ body, ack, say }) => { await ack(); // no specific action needed }); // Start the Bolt app (async () => { await app.start(port); console.log("⚡️ Coder Slack bot is running!"); })(); -
Set environment variables to identify the Slack app:
export SLACK_BOT_TOKEN=xoxb-... export SLACK_SIGNING_SECRET=0da4b... -
Start the web application by running:
node app.js
Enable Interactivity in Slack
Slack requires the bot to acknowledge when a user selects a URL action button. This is handled by setting up interactivity.
Under "Interactivity & Shortcuts" in your Slack app settings, set the Request URL to match the public URL of your web server's endpoint.
You can use any public endpoint that accepts and responds to POST requests with HTTP 200.
For temporary testing, you can set it to https://httpbin.org/status/200.
Once this is set, Slack will send interaction payloads to your server, which must respond appropriately.
Enable Webhook Integration in Coder
To enable webhook integration in Coder, define the POST webhook endpoint matching the deployed Slack bot:
export CODER_NOTIFICATIONS_WEBHOOK_ENDPOINT=http://localhost:6000/v1/webhook
Finally, go to the Notification Settings in Coder and switch the notifier to Webhook.