Managing email recipients

Overview

Kompass sends automated emails from several areas of the platform. The eight main notification areas each have their own set of templates and recipient controls. All templates are managed in Kompass Admin and follow the same pattern: you configure one or more recipient addresses on each template, and Kompass resolves those addresses at send time. Alongside standard email addresses, every event template type supports magic email addresses, special placeholders that resolve dynamically to the right person based on who is involved in the record being sent.


This article covers those eight areas, where to find their recipient settings, and a reference for their magic email addresses.



Part 1: How Recipients Work

Static addresses

You can enter any real email address directly into the Recipients field of a template. That address will receive every email sent by that template, regardless of which record triggered it.


Magic email addresses

Magic addresses use the format [email protected] . Instead of going to a fixed inbox, they resolve at send time to whoever holds that role on the specific record. For example, [email protected]  on a project email template will send to whichever user is the project manager on each project, so a single template covers all projects without needing a fixed address.


If a magic address cannot be resolved, for example, a project has no manager assigned, that recipient is silently skipped and no error is raised.


CC and BCC

Every event template type has separate CC and BCC fields. Any address in BCC is blind-copied on every email sent by that template, regardless of the Recipients field. This is useful for compliance or monitoring inboxes. CC works the same way, but everyone on the email can see those addresses. Magic addresses work in both fields, except for task notifications: their sender ignores the template’s CC field, and BCC supports only literal addresses, so a task-specific magic address such as [email protected] does not resolve there.


Part 2: Email Areas and Where to Configure Them

1. Projects

Admin path: Kompass Admin → Projects → Email Templates


When emails are sent: Whenever a project moves through a workflow stage. One email template can be created per trigger. If multiple templates exist for the same trigger on the same org, all of them fire.


Available triggers:

Trigger When it fires
Created A new project is created
Quote requested The Requested date is set
Quote submitted The Quoted date is set
Quote accepted The project is accepted (first proposal item accepted)
Field work complete The Surveyed date is set
Office work complete The Processed date is set
Check complete The Checked date is set
Project delivered The Delivered date is set
Project invoiced The Invoiced date is set
Payment received The Received date is set
Project Suspended Not currently sent. The trigger exists as an option, but suspending a project does not send an email.
Project Unsuspended Not currently sent. The trigger exists as an option, but clearing a suspension does not send an email.
Quote abandoned/cancelled The project is abandoned
Estimator assigned/changed The project's Proposal Writer (estimator) is assigned or changed
Modified (will ALWAYS trigger) Any change is saved on the project (always fires alongside the above)
Document Sending (manual) A document is manually sent from the project
Phase completed A phase is completed; set the Phase field on the template to limit it to one phase

Available magic addresses:

Magic address Resolves to
[email protected] User who set the abandoned date
[email protected] User who checked the project
[email protected] User who created the project
[email protected] User who marked the project delivered
[email protected] User who set the invoiced date
[email protected] Project manager
[email protected] User who made the most recent change
[email protected] User who completed the phase with that code (for example, [email protected])
[email protected] User who processed the project
[email protected] User who quoted the project
[email protected] User who set the received date
[email protected] User who surveyed the project
[email protected] User who suspended the project
[email protected] Contact who accepted the project
[email protected] Project contact (Client Project Manager)
[email protected] All Invoice Contacts on the project
[email protected] Contact who requested the project
[email protected] Billing contact of the client
[email protected] Primary contact of the client

Note: The Document Sending trigger fires when a user manually emails a document from a project. The To addresses are chosen in the send dialog, prefilled with the project's Enquiry By and Client Project Manager contacts. The CC list starts with the signed-in user, and any CC recipients configured on the template are added when sending. The template's Recipients field is not used for that send.



2. Proposal Items

Admin path: Kompass Admin → Quote Items → Email Templates


When emails are sent: When a proposal item changes state within a project.


Available triggers:

Trigger When it fires
Quote Item created A new proposal item is created
Quote Item accepted The proposal item is accepted
Quote Item delivered (project delivered) The parent project is delivered
Quote Item closed A closed date is set on the proposal item
Quote Item reopened (closed cleared) The closed date is cleared
Quote Item abandoned (project abandoned, item not accepted) The project is abandoned and the proposal item was not accepted
Quote Item cancelled (project abandoned, item accepted) The project is abandoned and the proposal item was accepted
Quote Item modified (will ALWAYS trigger) Any change is saved (always fires alongside the above)

Available magic addresses:

Magic address Resolves to
[email protected] Contact who accepted the proposal item
[email protected] User who created the proposal item
[email protected] User who last modified the proposal item
[email protected] Manager of the parent project
[email protected] User who quoted the parent project

3. Tasks

Admin path: Kompass Admin → Tasks → Email Templates


When emails are sent: When a task is created, assigned, scheduled, completed, or closed.


Available triggers:

Trigger When it fires
Task Created A new task is created
Assignment added to task A user is added to the task's team
Assignment removed from task A user is removed from the task's team
Task scheduled (has dates and assigned users) The task is placed on the schedule
Assignment marked done A specific team member marks their assignment complete
Assignment marked undone A completed assignment is marked incomplete again
Assignments of task all done All team members have marked the task complete
Task closed A closed date is set on the task
Task Modified (will ALWAYS trigger) Any change is saved (always fires alongside the above)

Available magic addresses:

Magic address Resolves to
[email protected] All users currently assigned to the task
[email protected] The specific user being assigned (Assignment added to task only)
[email protected] The specific user being removed (Assignment removed from task only)
[email protected] The user who marked their assignment done
[email protected] User who created the task
[email protected] User who last modified the task
[email protected] Manager of the task's parent project
[email protected] User who quoted the task's parent project


4. Clients

Admin path: Kompass Admin → Clients → Email Templates (Clients)


When emails are sent: When a client record is created or certain contacts or managers change.


Available triggers:

Trigger When it fires
Client created A new client is created
Manager changed The client's account manager is changed
Primary contact changed The primary contact on the client is changed
Billing contact changed The billing contact on the client is changed
Client marked inactive The client is marked inactive
Client modified (will ALWAYS trigger) Any change is saved (always fires alongside the above)

Available magic addresses:

Magic address Resolves to
[email protected] The client's billing contact
[email protected] User who created the client record
[email protected] The client's account manager
[email protected] User who last modified the client
[email protected] The client's primary contact


5. Invoices

Admin path: Kompass Admin → Clients → Invoice Email Templates


When emails are sent: When an invoice moves through its approval workflow, or when it is manually sent to a client.


Available triggers:

Trigger When it fires
Created A new invoice is created
Submitted The invoice is submitted for approval
Approved The invoice is approved
Rejected The invoice is rejected
Posted The invoice is posted
Voided The invoice is voided
Invoice Sending The invoice is manually sent to the client
Modified (will ALWAYS trigger) Any change is saved (always fires alongside the above)

Note: The Invoice Sending trigger is special. It is triggered manually from the invoice and the sender identity is set to the requesting user's name and email, not the platform default.


Available magic addresses:

Magic address Resolves to
[email protected] User who created the invoice
[email protected] User who submitted the invoice
[email protected] User who approved the invoice
[email protected] User who rejected the invoice
[email protected] User who posted the invoice
[email protected] User who voided the invoice
[email protected] Manager of the invoice's parent project
[email protected] User who quoted the invoice's parent project

6. Expenses

Admin path: Kompass Admin → Expenses → Email Templates


When emails are sent: When an expense record is created, assigned, submitted, or reaches a decision point.


Available triggers:

Trigger When it fires
Created A new expense is created
Assigned to different User The expense is assigned to a user
Submitted The expense is submitted for approval
Checked The expense is checked
Approved The expense is approved
Rejected The expense is rejected
Modified (will ALWAYS trigger) Any change is saved (always fires alongside the above)

Available magic addresses:

Magic address Resolves to
[email protected] The user the expense is assigned to
[email protected] The manager of the assigned user
[email protected] User who created the expense
[email protected] User who submitted the expense
[email protected] User who checked the expense
[email protected] User who approved the expense
[email protected] User who rejected the expense
[email protected] User who last modified the expense
[email protected] Manager(s) of the project(s) the expense is allocated to

7. Leave

Admin path: Kompass Admin → Leave → Email Templates


When emails are sent: When a leave request is made or a decision is recorded.


Available triggers:

Trigger When it fires
Requested A new leave request is submitted
Approved The leave request is approved
Denied The leave request is denied

Note: Whether a leave email includes an ICS calendar invite depends on the template’s Invite mode. None sends the email without an invite, Inline embeds the invite in the email so the recipient can accept or decline it, and Attached supplies a downloadable .ics file. Approval alone does not guarantee an attachment.


Available magic addresses:

Magic address Resolves to
[email protected] The employee who requested leave
[email protected] The employee's manager
[email protected] The employee's manager if set; otherwise the same group as [email protected]
[email protected] Internal users in the same org with no manager and no employment end date, excluding the user who requested the leave. This is not a director role.
[email protected] Users with permission to approve leave for their own department

8. Comments

Admin path: Kompass Admin → Comments → Email Templates


When emails are sent: When a comment that contains a user mention is posted on a project, proposal item, or other commentable record. Editing a comment that contains a mention also sends a notification. Comments without a mention do not send email. Unlike other template types, there is one comment template per org rather than per trigger. All comment notifications use the same template.


Available magic addresses:

Magic address Resolves to
[email protected] User who posted the comment
[email protected] User who last edited the comment
[email protected] Any users @mentioned in the comment body

Note: Comment emails automatically include any files attached to the comment as email attachments.

Other email templates. The same Recipients, CC and BCC controls also appear on the Contacts (Kompass Admin → Contacts → Email Templates), Timesheets (Kompass Admin → Diary → Email Templates), captured replies (Kompass Admin → Emails → Email Templates), purchase order sending (Kompass Admin → Suppliers → Purchase Order Email Templates) and sign-in (Kompass Admin → Authentication and Authorization → Email Templates) templates. Each template's Recipients help text lists the magic addresses it supports.


Part 3: Digest Emails

Admin path: Kompass Admin → Digests → Digests


Digests are scheduled summary emails that run automatically on a cron schedule. Unlike the event-driven templates above, they do not fire in response to a specific action. They collect and summarize data from across the platform (equipment calibration dates, qualification expiry, pending time off requests, undecided proposals, active projects, invoices and scheduled tasks) and deliver it on a schedule you define.


Recipient configuration

Digest recipients are configured differently from the event templates. Instead of a Recipients array, digests have three template fields:


Field Description
To template Template rendered at send time. The variable users_active  is available, containing all active users in the org. When Send one email per is set, item  is also available for the client or user that email covers.
CC template Same as To template, rendered as CC recipients.
BCC template Same as To template, rendered as BCC recipients.

This means you can dynamically build the recipient list from active users rather than hardcoding addresses. For example, {{ users_active | map(attribute='email') | join(', ') }}  would send the digest to every active user.


Send one email per

The Send one email per field chooses whether a digest goes out as one message or as separate messages:

  • None: one email to the To list with all the data.
  • Client: one email per client with its outstanding invoices and its undecided and active projects. item  holds the client and its grouped project and invoice data; the client itself is item.client.
  • User: one email per active user with their scheduled tasks and the active projects they manage. item  and user  are the user.
  • Leave requests: one email per active user who can see at least one pending leave request. item  holds the user and the leave requests they can see.

With User and Leave requests, only the recipient's own address is kept from the To list, so a To template that lists every user still sends each person only their own email.


Opt-out

Individual users can be opted out of a digest without modifying the template. Go to Kompass Admin → Digests → User digests and create a record linking the user and the digest with Disabled ticked. That user will be excluded from future sends of that digest.



Part 4: Document and Report Templates (Sending, Not Notifications)

Document templates (proposals, invoices, letters) and report templates (Excel exports) do not have their own event notification templates. When you email a document from a project, choose a template with the Document Sending trigger in the send dialog. The To addresses are chosen in that dialog, prefilled with the project's Enquiry By and Client Project Manager contacts. The CC list starts with the signed-in user, and any CC recipients configured on the template are added when sending; the template's Recipients field is not used for that send.


Report templates are downloaded directly by the user who requests them. They are not emailed automatically.



Part 5: The Sender Address

By default, Kompass sends notification email from a single system address, "Kompass BMS" <notifications@…>, on a sending domain Kompass keeps warmed. Each email template has a Sender template field that can override this on a per-template basis. The field is rendered with the same values as the email body, so it can name a person, for example the user who made the decision. Using an address outside your authorized sending domains may cause emails to be rejected or land in spam.


Manual sends set the sender to the requesting user's name and email instead: sending a document from a project, and sending an invoice. If that address is outside your authorized sending domains, the template's Sender template is used instead.


Recording replies

When email capture is on, clients' replies to Kompass notification emails are recorded against the contact. See Recording client emails.

Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.

Still need help? Contact Us Contact Us