TypeScript SDK

import { NotificationsClient, NotificationsError } from "@notifications/sdk";

function requiredEnv(
  name: "NOTIFICATIONS_API_KEY" | "NOTIFICATIONS_URL",
): string {
  const value = process.env[name];
  if (value === undefined || value.length === 0) {
    throw new Error(`Set ${name} before running this example.`);
  }
  return value;
}

const client = new NotificationsClient({
  apiKey: requiredEnv("NOTIFICATIONS_API_KEY"),
  baseUrl: requiredEnv("NOTIFICATIONS_URL"),
});

try {
  const result = await client.createNotification({
    title: "Deployment finished",
    body: "billing-api is healthy in production.",
    severity: "success",
    tags: ["production", "deploy"],
    source: "billing-api",
    externalId: "deploy-abc124",
    deduplicationKey: "deploy:billing-api:abc124",
    metadata: {
      environment: "production",
      commit: "abc124",
    },
    actions: [
      {
        id: "open-deploy",
        type: "link",
        label: "Open deployment",
        href: "https://example.com/deployments/abc124",
        style: "primary",
      },
    ],
  });

  process.stdout.write(`${JSON.stringify(result)}\n`);
} catch (error) {
  const safeError =
    error instanceof NotificationsError
      ? error.toJSON()
      : { kind: "unexpected_error" };
  process.stderr.write(`${JSON.stringify(safeError)}\n`);
  process.exitCode = 1;
}