Getting Started

Overview

Understand the package and choose the smallest integration that fits your application.

NotificationCompass adds a preference layer above Laravel's notification system. It resolves whether a notification may use a channel for a notifiable, optionally using a business context.

The package remains independent from your domain models. It stores the notifiable identity, notification key, channel, and context key without requiring a specific User, Team, or Organization implementation.

Documentation map

Installation

Install the package, publish its configuration, and run the migration.

Concepts

Learn how definitions, contexts, defaults, and resolution sources fit together.

Configuration

Configure definitions, channels, defaults, and custom providers.

API reference

Browse the managers, registry, gate, contracts, and value objects.

NotificationCompass follows the v1.x API contract. Review the release notes before upgrading.