Lynx SDK

TypeScript client for Lynx applications with fetch support.

Installation

npm install @notification-system/lynx-sdk

Requirements

Lynx runtime with fetch
TypeScript 5.7 or later for type checking

Quick Start

import { NotificationClient } from '@notification-system/lynx-sdk';

const client = new NotificationClient({
  apiKey: 'ntf_your_api_key_here',
});

const response = await client.sendNotification({
  channels: ['email', 'sms'],
  content: 'Hello from Lynx',
  targets: ['user@example.com', '+1234567890'],
});

console.log(response.id);

Platform Integration API Keys

const { integration } = await client.createIntegration('project-id', {
  name: 'Production Lynx App',
  platform_type: 'lynx',
  environment: 'production',
  sdk_language: 'lynx',
});

const key = await client.createApiKey(
  integration.id!,
  'Lynx app key',
);

API Methods

sendNotification(request)

Send to email, SMS, Slack, Telegram, WhatsApp, WebSocket, or MQTT channels.

listWorkspaces()

List workspaces available to the authenticated user.

createProject(workspaceId, name, description)

Create a workspace project.

createIntegration(projectId, integration)

Create a platform integration.

createApiKey(integrationId, description)

Create a key scoped to one platform integration.