Skip to main content

Notifications

Atrium sends email notifications at key points in the visitor lifecycle. Notifications use a provider-agnostic adapter pattern — currently email via SMTP, with other channels (SMS, push) possible in future versions.

Notification events

EventRecipientContent
Pre-registrationVisitorQR code, visit details, check-in instructions, optional pre-signing link.
Visitor checked inHostNotification that their visitor has arrived, with visitor name and check-in time.

These are the core notifications. Additional notification types (visitor checked out, visit cancelled, visit reminder) may be added based on demand.

SMTP configuration

Email delivery requires SMTP configuration. In SaaS deployments, SMTP is pre-configured. In self-hosted deployments, you configure SMTP via environment variables:

VariableDescriptionExample
SMTP_HOSTSMTP server hostnamesmtp.mailgun.org
SMTP_PORTSMTP port587
SMTP_USERSMTP username / loginpostmaster@mg.example.com
SMTP_PASSSMTP password(your SMTP password)
SMTP_FROMSender address for all emailsnoreply@example.com
SMTP_SECUREUse TLS (true for port 465, false for STARTTLS on 587)false

Most transactional email providers work: Mailgun, SendGrid, Amazon SES, Postmark, or your own mail server.

Testing email delivery

In development, Atrium uses Mailpit — a local email testing tool that captures all outgoing emails without delivering them. Mailpit's web interface is available at http://localhost:8025 when the dev compose stack is running.

For self-hosted production deployments, send a test email after configuring SMTP:

  1. Create a test visit with a valid email address.
  2. Check that the pre-registration email arrives.
  3. If it doesn't, check the backend logs for SMTP errors.

Email content

Pre-registration email

The pre-registration email contains:

  • QR code — As an inline PNG image, scannable at the kiosk.
  • Deep link — A URL (https://{domain}/checkin?token=...) as an alternative to scanning. The visitor can open this on their phone.
  • Visit details — Date, time, host name, site address.
  • Check-in instructions — Brief guidance on what to expect at the kiosk.
  • Pre-signing link (if enabled) — A link to review and sign documents before arrival.

Host notification

The host notification is a brief email informing the host that their visitor has checked in:

  • Visitor name and company.
  • Check-in time.
  • Site name.

Notification preferences

Currently, notifications are sent automatically — there are no per-user notification preferences. All hosts receive check-in notifications for their visitors.