How Do I

How Do I

Short task-oriented guides for common NotificationCompass goals.

Use this section when you already know the outcome you want and only need the shortest route to it.

Guides

Define notification types

Integrate notification channels

Connect mail, database, broadcast, Slack, Vonage, and custom channels.

Build a settings screen

Display effective preferences and let users change the modifiable values.

Use contextual preferences

Store user preferences or policies for an organization, team, project, or another scope.

Authorize context access

Restrict contextual preferences and delivery to authorized members.

Check a notification

Ask the gate whether a notification can use a channel before sending it.

Replace a default resolver

Bind custom context or preference storage services.

Listen for preference changes

React to preference and context policy changes with Laravel events.

Each page is intentionally short. Start here first, then jump into the reference docs when you need the exact API surface.

Storage and persistence

Understand the default Eloquent store and the preference table schema.

Define notification types