RhdhNotificationsApi API

Typed REST helper for the RHDH notifications API.

Import

import {
  RhdhNotificationsApi,
  type NotificationRequest,
  type NotificationPayload,
  type NotificationRecipients,
  type NotificationSeverity,
} from "@red-hat-developer-hub/e2e-test-utils/helpers";

Factory

build()

static async build(token: string): Promise<RhdhNotificationsApi>

Creates an API client using ${RHDH_BASE_URL}/api/ as the base URL.

Methods

createNotification()

async createNotification(
  notification: NotificationRequest,
): Promise<APIResponse>

POST /api/notifications

markAllNotificationsAsRead()

async markAllNotificationsAsRead(): Promise<APIResponse>

PATCH /api/notifications with { ids: [], read: true }.

Types

NotificationSeverity

type NotificationSeverity = "critical" | "high" | "normal" | "low";

NotificationRequest

interface NotificationRequest {
  recipients: NotificationRecipients;
  payload: NotificationPayload;
}

BroadcastRecipients

type BroadcastRecipients = { type: "broadcast" };

EntityRecipients

type EntityRecipients = {
  type: "entity";
  entityRef: string | string[];
  excludeEntityRef?: string | string[];
};

Related Pages

• RhdhNotificationsApi Guide — usage examples