Skip to main content

Introduction

Welcome to the LSS Notification documentation. This document provides detailed information about the LSS Notification system, including how it works, configuration requirements, and message formats.

Overview

LSS Notification is designed to send various types of information generated by the LSS (Low-latency Streaming Service) to your predefined endpoints via HTTP requests. When necessary, LSS will send results, status updates, and error information to help you achieve automated system integration.

The notification system enables you to:

  • Receive real-time processing results
  • Monitor status changes of LSS operations
  • Get error notifications for timely troubleshooting
  • Automate workflows based on LSS events

Key Features

FeatureDescription
HTTP CallbacksLSS sends notifications to your endpoint using standard HTTP requests
JSON Data FormatAll notifications use JSON format for consistent and efficient data exchange
Configurable EndpointsYou can specify which endpoint should receive which types of notifications
Comprehensive Event TypesNotifications cover processing results, status changes, and error conditions
Reliable DeliveryIncludes retry mechanisms to ensure notification delivery

Implementation Requirements

Setting Up Your Endpoint

Important: To receive LSS notifications, you must set up an HTTP endpoint that can accept POST requests. This endpoint will receive JSON-formatted messages from the LSS system.

Your endpoint should:

  • Be publicly accessible over the internet
  • Accept HTTP POST requests
  • Process JSON payloads
  • Ensure your endpoint has high availability

Configuring LSS to Use Your Endpoint

After setting up your endpoint, you need to configure it in the LSS system:

  • Log into your LSS administration console
  • Navigate to the Notification Configuration section under Settings
  • Enter your endpoint URL
  • Save your configuration

Best Practices

Handling Notifications

  • Implement idempotent processing to handle potential duplicate notifications
  • Process notifications asynchronously to avoid blocking your endpoint
  • Implement proper error handling and logging
  • Set up monitoring for your notification endpoint
  • Consider implementing a queue system for high-volume notifications

Endpoint Reliability

  • Ensure your endpoint has high availability
  • Implement proper error handling
  • Return HTTP 200 status code promptly to acknowledge receipt
  • Process the notification content asynchronously after acknowledging