Notification

import { githubSummary, slackWebhook, teamsWebhook, discordWebhook, email, webhook } from "@swenyai/providers/notification";

Interface

interface NotificationProvider {
  send(payload: NotificationPayload): Promise<void>;
}

interface NotificationPayload {
  title?: string;
  body: string;
  format?: "markdown" | "html" | "text";
}

GitHub Summary

Writes to the GitHub Actions Job Summary:

const notifier = githubSummary({ logger: myLogger });

Requires @actions/core as a peer dependency. Only works inside GitHub Actions.

Slack Webhook

const notifier = slackWebhook({
  webhookUrl: process.env.SLACK_WEBHOOK_URL!,
  logger: myLogger,
});

Teams Webhook

const notifier = teamsWebhook({
  webhookUrl: process.env.TEAMS_WEBHOOK_URL!,
  logger: myLogger,
});

Discord Webhook

const notifier = discordWebhook({
  webhookUrl: process.env.DISCORD_WEBHOOK_URL!,
  logger: myLogger,
});

Sending a notification

All providers share the same send() method:

await notifier.send({
  title: "SWEny Triage Complete",
  body: "Found 3 novel issues. Created ENG-456, ENG-457. Opened PRs #89, #90.",
  format: "markdown",
});

Email

const notifier = email({
  apiKey: process.env.SENDGRID_API_KEY!,
  from: "sweny@mycompany.com",
  to: ["oncall@mycompany.com", "team-lead@mycompany.com"],
  logger: myLogger,
});

Uses the SendGrid v3 API. Native fetch only.

Generic Webhook

const notifier = webhook({
  url: "https://hooks.mycompany.com/sweny",
  headers: { Authorization: "Bearer my-token" },
  signingSecret: process.env.WEBHOOK_SECRET,  // optional, HMAC-SHA256
  logger: myLogger,
});

POSTs JSON { title, body, format, timestamp }. Supports HMAC-SHA256 signing via X-Signature-256 header.

The notification provider is fire-and-forget — there’s no message ID or threading. For two-way conversations, see the Messaging provider.