Add api route

Author: Aayush-Agnihotri

.env.template

@@ -13,4 +13,6 @@ FORM_TRACKER_ID=
 TRACKER_SHEET_NAME=
 FORM_INFO_SHEET_NAME=
 
-PORT=3000
+# Express server configuration
+PORT=
+API_SECRET=

README.md

@@ -119,3 +119,26 @@ Configurable coffee chat pairings to help team members get to know each other be
   - **⏸️ Pause Future Pairings** — Opt out of all future pairings
 - After opting out, a **▶️ Resume Pairings** button lets users opt back in
 - Pairings are tracked in MongoDB to prevent frequent repeats
+
+### 3. API Endpoints
+
+The bot exposes an HTTP server (default port `3000`) designed to receive notifications from external services.
+
+#### `POST /api/send-message`
+
+Sends a message or a rich Block Kit payload to a specified Slack channel as the bot.
+
+**Headers:**
+
+- `Authorization: Bearer <API_SECRET>`
+- `Content-Type: application/json`
+
+**Body Payload:**
+
+```json
+{
+  "channelId": "C01234567",
+  "text": "Fallback notification text",
+  "blocks": []
+}
+```

package-lock.json

@@ -9,6 +9,7 @@
     "@typegoose/typegoose": "^13.1.0",
     "@types/node": "^24.10.13",
     "dotenv": "^17.3.1",
+    "express": "^5.2.1",
     "google-auth-library": "^10.5.0",
     "google-spreadsheet": "^5.2.0",
     "moment-timezone": "^0.6.0",
@@ -28,6 +29,7 @@
   },
   "devDependencies": {
     "@eslint/js": "^10.0.1",
+    "@types/express": "^5.0.6",
     "@types/jest": "^29.5.14",
     "@types/node-cron": "^3.0.11",
     "eslint": "^10.0.2",

package.json

@@ -0,0 +1,39 @@
+import express, { Express } from "express";
+import slackbot from "../slackbot";
+import { logWithTime } from "../utils/timeUtils";
+
+export const registerApiRoutes = (app: Express) => {
+  app.use(express.json());
+
+  app.post("/api/send-message", async (req, res) => {
+    const authHeader = req.headers.authorization;
+    const apiSecret = process.env.API_SECRET;
+
+    if (!apiSecret || authHeader !== `Bearer ${apiSecret}`) {
+      res.status(401).send({ success: false, error: "Unauthorized" });
+      return;
+    }
+
+    const { channelId, text, blocks } = req.body;
+
+    if (!channelId || !text) {
+      res
+        .status(400)
+        .send({ success: false, error: "Missing channelId or text" });
+      return;
+    }
+
+    try {
+      await slackbot.client.chat.postMessage({
+        channel: channelId,
+        text: text,
+        ...(blocks ? { blocks } : {}),
+      });
+      res.status(200).send({ success: true });
+    } catch (error) {
+      const err = error as Error;
+      logWithTime(`Error sending slack message: ${err.message}`);
+      res.status(500).send({ success: false, error: err.message });
+    }
+  });
+};

src/api/routes.ts

@@ -1,8 +1,10 @@
 import cron from "node-cron";
+import express from "express";
 import { dbConnect } from "./database";
-import { sendFormReminders } from "./forms/formService";
+// import { sendFormReminders } from "./forms/formService";
 import slackbot from "./slackbot";
 import { logWithTime } from "./utils/timeUtils";
+import { registerApiRoutes } from "./api/routes";
 import {
   createNewCoffeeChatRounds,
   reportStats,
@@ -15,10 +17,10 @@ import { registerWelcomeHandler } from "./coffeeChats/coffeeChatWelcome";
 export const SEMESTER = "sp24";
 export const DEFAULT_PAIRING_FREQUENCY_DAYS = 14; // Default to every 2 weeks
 
-const initializeFormServices = async () => {
-  await sendFormReminders();
-  setInterval(sendFormReminders, 1000 * 60 * 60 * 24); // Run every 24 hours
-};
+// const initializeFormServices = async () => {
+//   await sendFormReminders();
+//   setInterval(sendFormReminders, 1000 * 60 * 60 * 24); // Run every 24 hours
+// };
 
 const initializeCoffeeChatServices = async () => {
   // Register coffee chat actions and commands
@@ -57,10 +59,18 @@ const initializeCoffeeChatServices = async () => {
   logWithTime("✅ Midway reminders scheduled to run daily at 4pm");
 };
 
+// Set up custom API endpoints
+const apiServer = express();
+registerApiRoutes(apiServer);
+
 export const startServer = async () => {
   await dbConnect();
   logWithTime("✅ Connected to MongoDB");
-  await slackbot.start(process.env.PORT || 3000);
+  await slackbot.start();
+  const port = Number(process.env.PORT) || 3000;
+  apiServer.listen(port, () => {
+    logWithTime(`✅ API Server listening on port ${port}`);
+  });
   logWithTime("✅ Slackbot up and running!");
 
   // Currently unused, so commenting out to avoid unnecessary API calls and logs. Can re-enable when form services are needed.

src/app.ts

@@ -164,7 +164,7 @@ export function registerCoffeeChatCommands(slackbot: App) {
             type: "section",
             text: {
               type: "mrkdwn",
-              text: `📅 Next automatic pairing will be on ${nextPairingDate.format("dddd (MMM Do)")} at ${nextPairingDate.format("h:mm A z")}`,
+              text: `📅 Next automatic pairing will be on ${nextPairingDate.format("dddd (MMM Do)")}`,
             },
           },
         ],
@@ -385,7 +385,11 @@ export function registerCoffeeChatCommands(slackbot: App) {
           let status = "";
           if (pairing.meetupConfirmed) {
             status = "✅ Met";
-          } else if (moment(pairing.dueDate).tz("America/New_York").isAfter(moment().tz("America/New_York"))) {
+          } else if (
+            moment(pairing.dueDate)
+              .tz("America/New_York")
+              .isAfter(moment().tz("America/New_York"))
+          ) {
             status = "⏳ Pending";
           } else {
             status = "❌ Did not meet";