Setting up notifications in Hypha¶

As mentioned in External Integrations, Hypha offers notifications via e-mail and/or Slack.

Notification providers setup¶

Hypha sends messages via configured providers such as email or Slack.

Email¶

For information on configuring email notifications for Hypha, see the E-mail section of the configuration reference.

Slack¶

For information on configuring Slack notifications for Hypha, see the Slack section of the configuration reference.

Project report reminders¶

To send reminders for upcoming due reports, configure the following three things.

Wagtail administration project settings for report reminders¶

Visit Wagtail admin, click Projects -> Project Settings (or URL /admin/settings/application_projects/projectsettings).

Scroll down to add "Report reminder frequency" configurations. Click "Add report reminder frequency" for each reminder.

Script to run `notify_report_due` command¶

Create a script that runs the django manage command notify_report_due.

For example,

#!/bin/bash

APP_ROOT=/opt/hypha
cd "${APP_ROOT}" || exit 1
export DJANGO_SETTINGS_MODULE="hypha.settings.production"

exec venv/hypha/bin/python3 manage.py notify_report_due

The example assumes Hypha is installed at /opt/hypha, uses a virtual environment venv/hypha, with production settings. Adjust as needed for your environment and settings. Make sure that the settings has SEND_MESSAGES = True.

Mechanism to run the above script¶

Create a regularly executing task that runs the above script.