Events and notifications.

The package dispatches a domain event for every state change your application can react to. The notification dispatcher listens to eight of them, and the audit recorder listens to the state-changing events it records.

Every event implements ShouldDispatchAfterCommit.

Event payloads

VisibilityChanged::becameNotApplicable(): bool reports the direction of a flip.

ItemFailed accompanies ItemAnswered when the shared type-handler predicate reports a score of exactly zero. RequirementsUnmet reports an accepted answer that still needs a note or evidence.

Shipped notification mapping

One model filling several roles receives one notification. Null recipients and objects without Laravel's Notifiable trait are skipped.

Notification channels and payload

Every shipped class extends ChecklistNotification and returns mail and database from via().

The database payload contains:

[
    'event' => 'assigned',
    'checklist_id' => $checklist->id,
    'template_version_id' => $checklist->template_version_id,
    'template' => 'Vehicle inspection',
    'status' => 'pending',
    'due_at' => $checklist->due_at?->toIso8601String(),
    'message' => '...',
]

Delivery failures are reported through Laravel's exception handler and do not undo the checklist operation that triggered them.

Listening to an event

use ByRcsc\LaravelChecklist\Events\ChecklistCompleted;
use Illuminate\Support\Facades\Event;

Event::listen(ChecklistCompleted::class, function (
    ChecklistCompleted $event,
): void {
    // Queue application-specific follow-up work.
});

What to read next

• Customize notifications to replace classes or recipient routing.
• Audit history to see which events create action rows.
• Testing to fake and assert events and notifications.