Skip to main content

White Listing - How to Customize Your Notifications

Introduction

Mirah supports a variety of ways to customize the appearance of the platform to display more of a customer’s brand identity. This can help patients understand who is sending messages, and make patients more likely to engage with assessments that they know come from a trusted source.

Some of these can be set directly by you. Others require you to contact support.

In the examples throughout, we will be using “Test Hospital” as the example name.

Using Placeholders in Templates​

Many of the settings below support placeholder substitution. This allows you to change the content dynamically to include things like the patient’s name, the respondent’s name, or the name of the unit/organization providing care.

For example:

Hi %{recipient_first_name}, %{client_facing_org_name} would like you to take an assessment for %{patient_possive} appointment on %{date}

Would look as follows when received by a patient called John:

Hi John, Test Hospital’s Outpatient Unit would like you to take an assessment for your appointment on 8/25

But when used instead to generate a notification for the Alice, the adult caregiver of a child named Ben in the IOP unit, would look like this:

Hi Alice, Test Hospital’s Child IOP Unit would like you to take an assessment for Ben’s appointment on 8/25

Supported Options​

Email​

OptionDescriptionRequirements and LimitationsHow to change
Email SubjectChanges the subject line of assessment emails. The default value is “Assessment from Test Hospital”NoneChange the assessmentEmailSubject configuration valueContact support if you are uncomfortable doing this without assistance
Email SenderChanges the name and email address from which notifications are sent.By default, it is: “Mirah noreply@mirah.com”.Changes to the name but not the domain (e.g. “Test Hospital Assessments”If you wish to change the domain to a different one, e.g. “help@testhospital.com”, you must also configure a Custom Mail Server below.Change the assessmentSenderEmailAddress configuration valueContact support if you are uncomfortable doing this without assistance.
*Email Body TextAllows certain parts of the email body to be changed.The text can include variables like the patient’s name - see Using Placeholders in templates below for detailsFor first time emails, change the welcomeAssessmentEmailContent configuration value.For ongoing assessments, change the ongoingAssessmentEmailContent configuration value.Contact support if you are uncomfortable doing this without assistance
Custom Mail ServerIf you wish to send emails from your own domain, you must give Mirah login information that allows us to send emails on your behalf.We require the following details:Address, e.g. smtp.testhospital.comPort, e.g. 687Domain for email sending, e.g. testhospital.comUsernamePasswordServer must have TLS SupportedContact Support
Customer Logo in EmailImage must be a transparent PNGContact Support

Text Message​

OptionDescriptionRequirements and LimitationsHow to change
Text Message SenderChanges the number from which text messagesWe support Twilio SMS.Contact Support
Text Message ContentAllows the content of the text message to be customized.You may change the text for first time assessments, ongoing assessments, and reminders for uncompleted assessments.The message template supports placeholdersYou may change the following configuration properties:welcomeAssessmentTextContentongoingAssessmentTextContentreminderAssessmentTextContent

*Note that at this time we do not support color or theme changes to emails. Some parts of the emails, for example the greeting, and signature etc, are not currently configurable. These include elements which ensure that if multiple emails for different participants are sent to the same address for multiple participants, it is clear which is for each.