@forge/notification

Library for Forge Notification

Usage example

Sending a notification

import { 
  NotificationApi, 
  NotificationPayload,
  InvalidPayloadError,
  RateLimitError,
  InternalServerError 
} from '@forge/notification';

const notificationApi = new NotificationApi();

const payload: NotificationPayload = {
  context: {
    subject: 'Welcome to our app!',
    htmlBody: '<h1>Welcome!</h1><p>Thank you for joining us.</p>',
  },
  recipientsUserIds: ['user1', 'user2', 'user3']
};

try {
  const response = await notificationApi.sendNotification(payload);
  console.log('Trigger ID:', response.triggerId);
} catch (error) {
  if (error instanceof InvalidPayloadError) {
    console.error('Invalid payload:', error.message);
  } else if (error instanceof RateLimitError) {
    console.error('Rate limit exceeded:', error.message);
  } else if (error instanceof InternalServerError) {
    console.error('Server error:', error.message);
  }
}

Errors

The SDK throws validation and API Errors.