@mushi-mushi/plugin-msteams

Mushi Mushi plugin: post Adaptive Card 1.4 notifications to a Microsoft Teams Incoming Webhook for the major report lifecycle events.

Install

npm i @mushi-mushi/plugin-msteams

Run as a stand-alone server

MUSHI_PLUGIN_SECRET=...        # set when the plugin is installed in Mushi admin
TEAMS_WEBHOOK_URL=https://...  # Microsoft Teams Incoming Webhook URL
ADMIN_BASE_URL=https://...     # Mushi admin base URL (deep-links)
PORT=3000                      # optional
npx mushi-plugin-msteams

Install Microsoft Teams in the Mushi admin Marketplace and point its webhook_url at https://your-host/mushi/webhook.

Programmatic usage

import { createMsTeamsPlugin } from '@mushi-mushi/plugin-msteams'
import express from 'express'
import { expressMiddleware } from '@mushi-mushi/plugin-sdk'

const handler = createMsTeamsPlugin({
  webhookUrl: process.env.TEAMS_WEBHOOK_URL!,
  adminBaseUrl: process.env.ADMIN_BASE_URL!,
  mushiSecret: process.env.MUSHI_PLUGIN_SECRET!,
})

express().post('/mushi/webhook', expressMiddleware(handler)).listen(3000)

Subscribed events

• report.classified — Adaptive Card with severity-coloured accent.
• fix.proposed — Adaptive Card with PR link if available.
• fix.applied — green confirmation card.

Notes

• Adaptive Card schema version 1.4 so cards render correctly in modern Teams clients (desktop ≥ 1.5.x, mobile ≥ April 2024 release).
• All webhook calls retry transient 5xx via withRetry from @mushi-mushi/plugin-sdk.

License

MIT