From 13d227e953e404839690af566f6ff9693afdee4e Mon Sep 17 00:00:00 2001 From: Kai Dubauskas Date: Mon, 9 Feb 2026 12:23:06 -0500 Subject: [PATCH] docs:add report Signed-off-by: Kai Dubauskas --- .../report.api.md | 17 +++++++++++++++++ .../src/extensions.ts | 3 +++ 2 files changed, 20 insertions(+) diff --git a/plugins/notifications-backend-module-slack/report.api.md b/plugins/notifications-backend-module-slack/report.api.md index 3c4ddb494d..6fb477c1ee 100644 --- a/plugins/notifications-backend-module-slack/report.api.md +++ b/plugins/notifications-backend-module-slack/report.api.md @@ -4,6 +4,9 @@ ```ts import { BackendFeature } from '@backstage/backend-plugin-api'; +import { ExtensionPoint } from '@backstage/backend-plugin-api'; +import { KnownBlock } from '@slack/web-api'; +import { NotificationPayload } from '@backstage/plugin-notifications-common'; // @public export const ANNOTATION_SLACK_BOT_NOTIFY = 'slack.com/bot-notify'; @@ -11,4 +14,18 @@ export const ANNOTATION_SLACK_BOT_NOTIFY = 'slack.com/bot-notify'; // @public const notificationsModuleSlack: BackendFeature; export default notificationsModuleSlack; + +// @public +export interface NotificationsSlackBlockKitExtensionPoint { + // (undocumented) + setBlockKitRenderer(renderer: SlackBlockKitRenderer): void; +} + +// @public (undocumented) +export const notificationsSlackBlockKitExtensionPoint: ExtensionPoint; + +// @public (undocumented) +export type SlackBlockKitRenderer = ( + payload: NotificationPayload, +) => KnownBlock[]; ``` diff --git a/plugins/notifications-backend-module-slack/src/extensions.ts b/plugins/notifications-backend-module-slack/src/extensions.ts index 0229e6fd58..c2465b69cf 100644 --- a/plugins/notifications-backend-module-slack/src/extensions.ts +++ b/plugins/notifications-backend-module-slack/src/extensions.ts @@ -26,6 +26,9 @@ export type SlackBlockKitRenderer = ( /** * @public + * + * Extension point for customizing how notification payloads are rendered into + * Slack Block Kit messages before they're sent. */ export interface NotificationsSlackBlockKitExtensionPoint { setBlockKitRenderer(renderer: SlackBlockKitRenderer): void;