Notifications Integration Guides

Welcome to the Notifications Integration Guides for the Agglestone Messaging Service! These guides provide step-by-step instructions, code examples, and best practices for integrating notification functionality into your applications.

Getting Started

If you’re new to the Agglestone Messaging Service notifications functionality, start with the Quick Start Guide – Notifications. It will help you get notifications working in your application in minutes using the SignalR client library.

Available Guides

Quick Start Guide – Notifications

Get up and running quickly with notification functionality. Learn how to establish WebSocket connections using SignalR, handle messaging events, and fetch full notification details. Perfect for developers who want to add notifications to their application fast.

Creating and Sending Notifications

Complete guide to creating and sending notifications to users. Learn how to:

• Create notifications with different types and priorities
• Send notifications with optional email delivery
• Schedule notifications for future delivery
• Include rich HTML content and metadata
• Handle all notification options and configurations

Notification Events and Retrieving Notifications

Comprehensive guide to retrieving notifications, including:

• Setting up WebSocket connections for real-time events
• Retrieving individual notifications by ID
• Loading paginated notification lists from user inboxes
• Implementing infinite scroll for inbox interfaces
• Catching up after reconnection
• Best practices for avoiding duplicate notifications

Managing Notifications

Learn how to manage notifications in user inboxes. Discover how to:

• Mark notifications as read or unread
• Delete notifications permanently
• Implement “mark all as read” functionality
• Track unread notification counts
• Clean up old notifications

Integration Paths

For Frontend Developers

1. Start with the Quick Start Guide – Notifications to get basic notification functionality working
2. Review Notification Events and Retrieving Notifications to understand how to receive real-time notifications and load inbox history
3. Learn about Managing Notifications to implement read/unread states and deletion

For Backend Developers

1. Review Creating and Sending Notifications for API endpoints and request/response formats
2. Check Notification Events and Retrieving Notifications to understand notification retrieval and pagination
3. Review Managing Notifications for notification management APIs

For Full-Stack Developers

1. Follow the Quick Start Guide – Notifications for the complete notification integration flow
2. Review all guides to understand the full capabilities of the notification functionality
3. Implement Creating and Sending Notifications for sending notifications to users
4. Use Notification Events and Retrieving Notifications to handle real-time updates and inbox management
5. Implement Managing Notifications for notification state management

Standards and Protocols

The Agglestone Messaging Service notifications functionality is built on industry standards:

• WebSockets (RFC 6455) – Real-time bidirectional communication
• SignalR – Reliable WebSocket connections with automatic reconnection
• REST APIs – Standard HTTP conventions for all notification operations
• JWT Authentication – Secure, token-based access control

All guides use standard libraries and follow best practices, ensuring your integration is secure, reliable, and maintainable.

Need Help?

• API Documentation: Visit the Swagger UI for interactive API documentation
• Portal: Manage your tenant settings at https://portal.agglestone.com
• Overview: Check out the Service Overview for a high-level introduction
• Notifications Features: Learn about all notification capabilities in the Notifications Features guide

—

Ready to get started? Begin with the Quick Start Guide – Notifications and have notifications working in minutes!