> ## Documentation Index
> Fetch the complete documentation index at: https://help.propops.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Setting Up Notifications

> Configure in-app, email, push, and WhatsApp notifications for staff, agents, and contractors — with per-user preference controls.

PropOps delivers notifications across four channels: in-app, email, push, and WhatsApp. This guide covers setting up each channel and managing user preferences.

***

## In-app notifications

In-app notifications work out of the box — no setup required. The notification bell in the top navigation bar shows unread counts and opens the notification centre.

### Managing your notifications

* Select a notification to mark it as read and navigate to the relevant record.
* Use **Mark All Read** to clear all unread indicators.
* Filter by type — All, Unread, Case Notes, New Users, or Blacklist.
* Select **Clear All** to permanently remove all notifications from your centre.

***

## Email notifications

PropOps sends transactional emails via **Brevo** for events that need a persistent record.

### Setting up SMTP

Your administrator configures the email connection in the `.env` file:

```bash theme={null}
MAIL_HOST=smtp.mailgun.org
MAIL_PORT=587
MAIL_USERNAME=postmaster@mg.yourcompany.com
MAIL_PASSWORD=your_smtp_password
MAIL_FROM_ADDRESS=noreply@yourcompany.com
MAIL_FROM_NAME="PropOps"
MAIL_ENCRYPTION=tls
```

### Email threading

When you reply to a PropOps case note email, your reply is automatically added as a new case note on the relevant job. No copy-and-paste needed — the full conversation stays inside PropOps.

### Testing email delivery

```bash theme={null}
docker compose exec web php scripts/test-email.php you@yourcompany.com
```

***

## Push notifications

Push notifications appear as system notifications outside the browser — even when PropOps is not the active tab.

### Requirements

* HTTPS must be enabled on your PropOps instance.
* VAPID keys must be configured in your `.env` file.

### Generating VAPID keys

```bash theme={null}
docker compose exec web npm run generate-vapid
```

Add the output to your `.env`:

```bash theme={null}
VAPID_PUBLIC_KEY=your_generated_public_key
VAPID_PRIVATE_KEY=your_generated_private_key
VAPID_SUBJECT=mailto:you@yourcompany.com
```

Restart the web container after updating:

```bash theme={null}
docker compose restart web
```

### Installing the PWA

For the most reliable push notification experience, install PropOps as a Progressive Web App:

<Tabs>
  <Tab title="Desktop (Chrome / Edge)">
    1. Open PropOps in your browser.
    2. Look for the install icon in the address bar.
    3. Select **Install** and confirm.
    4. Grant notification permission when prompted.
  </Tab>

  <Tab title="Android (Chrome)">
    1. Open PropOps in Chrome.
    2. Tap **⋮ → Add to Home screen**.
    3. Open the installed app and grant notification permission.
  </Tab>

  <Tab title="iOS (Safari)">
    1. Open PropOps in Safari.
    2. Tap **Share → Add to Home Screen**.
    3. Open the app from your home screen.
    4. Grant notification permission when prompted by iOS.

    <Info>
      iOS push notifications only work when PropOps is opened from the home screen icon — not from the Safari browser tab.
    </Info>
  </Tab>
</Tabs>

***

## WhatsApp notifications

WhatsApp messages are sent to contractors and tenants using configurable templates. No WhatsApp Business API account or external credentials are required — PropOps generates a pre-filled WhatsApp message link.

### Setting up WhatsApp

1. Navigate to **Admin → WhatsApp Templates**.
2. Create your message templates with dynamic placeholders (e.g. `{job_ref}`, `{contractor_name}`, `{address}`).
3. Templates are available immediately — no external approval is needed.

### Sending a WhatsApp message from a job

1. Open the job.
2. Select **WhatsApp** from the top action bar.
3. Choose a message template from the dropdown.
4. Click **Send**. WhatsApp opens with the message pre-filled and the recipient's number set. Review and tap **Send** in WhatsApp.

<Info>
  The recipient must have an active WhatsApp account on their registered phone number.
</Info>

***

## User notification preferences

Each user controls which notifications they receive:

1. Select your avatar in the top navigation bar.
2. Go to **Profile → Notification Preferences**.
3. Toggle each notification type on or off for each channel (in-app, email, push).
4. Save your changes.

Security alerts and email verification messages are mandatory and cannot be disabled.

### Organisation-wide defaults

Your administrator can set default notification preferences for all users under **Admin → Settings → Notifications**. Individual users can then override these defaults from their own preferences page.
