Skip to main content

Appendix C — Email trigger reference

Each trigger below can be switched off, and its wording edited in each language, under Settings › Email Templates (Chapter 79); Email Logs records every send, including the ones skipped because a trigger is off (Chapter 91). Switching a trigger's email off does not silence any in-app notification that goes with it; those are controlled separately under Settings › Notifications. Where a row says "the employee", the email goes to the employee's work address, or to their personal address when no work address is on file.

Authentication​

TriggerWhenWho receives it
Forgot Password forgot_passwordWhen someone asks for a password reset link from the login pageThe person who asked, at their account email (only if they have an active account in a workspace)
Password Changed password_changedWhen a person changes their password from their account, or completes a password resetThe person whose password changed
Two-Factor Authentication Enabled two_factor_enabledWhen a person finishes turning on two-factor authenticationThat person
Two-Factor Authentication Disabled two_factor_disabledWhen a person turns off their own two-factor authenticationThat person
Two-Factor Authentication Reset by Administrator two_factor_resetWhen a user holding users.manage_2fa resets another user's two-factor authentication on the Users pageThe user whose two-factor authentication was reset

Employee Lifecycle​

TriggerWhenWho receives it
Welcome Employee welcome_employeeWhen HR clicks Run on the "Send welcome email" task of the employee's onboarding checklist (the task is due one day after joining)The new employee
Transfer Notice transfer_noticeWhen HR records a transfer for the employeeThe employee
Promotion Notice promotion_noticeWhen HR records a promotion for the employeeThe employee
Salary Increment salary_incrementWhen HR records a salary revision that raises pay, including applying a performance-based increment recommendationThe employee
Salary Decrement salary_decrementWhen HR records a salary revision that lowers payThe employee
Termination Notice termination_noticeNever sent. The older employee-separation endpoint that sent it has been removed; separations are recorded in Offboarding, which sends Separation Initiated instead. The template stays on the screen(nobody)
Resignation Acceptance resignation_acceptanceNever sent, as Termination Notice(nobody)
Retirement Notice retirement_noticeNever sent, as Termination Notice(nobody)
Account Setup Invitation account_setupWhen an admin clicks "Resend setup email" for a user on the Users page, or a person follows "First time signing in? Resend setup email" on the login pageThe user's account email (from the login page, only when an active account exists for that address)
Employee Account Invitation employee_invitationWhen an employee is added with portal access by invitation, or an admin sends or re-sends the invitation for an account that is linked to an employeeThe invited email address
Profile Submission — HR Review Needed profile_submission_pendingWhen a person submits changes from their personal profile for this workspace to reviewActive users holding employees.update (at most ten of them)
Profile Submission — Outcome profile_submission_reviewedWhen HR approves or rejects a profile submissionThe person who submitted it, at their account email in this workspace

Leave​

TriggerWhenWho receives it
Leave Applied leave_appliedWhen an employee applies for leaveThe employee's reporting manager; if they have no manager still employed with an email address, every active user holding both leave.approve and leave.view_all (never the applicant)
Leave Approved leave_approvedWhen an approver approves the leave applicationThe employee
Leave Rejected leave_rejectedWhen an approver rejects the leave applicationThe employee
Leave Cancelled leave_cancelledWhen the employee cancels their own leave applicationThe employee

Payroll​

TriggerWhenWho receives it
Payroll Processed payroll_processedWhen a payroll run is processed (one email per processed employee), and when HR bulk-emails salary slips, in which case the slip PDF is attachedThe employee
Salary Slip — Acknowledgement Request salary_slip_acknowledgement_requestWhen an entry is marked as paid with emails switched on (Mark as Paid, or issuing a cheque); when HR emails or re-sends an unacknowledged slip; and by a daily job, shortly after 9:00 workspace time, 2 and 5 days after the first request while the slip is still unacknowledgedThe employee
Salary Slip — Acknowledged (with PDF) salary_slip_acknowledgedWhen the employee confirms receipt in the portal, or when HR emails or re-sends a slip that is already acknowledged. The signed slip PDF is attachedThe employee
Bonus Awarded bonus_awardedWhen HR awards a bonusThe employee

Loans​

TriggerWhenWho receives it
Loan Approved loan_approvedWhen HR approves a loan applicationThe employee
Loan Rejected loan_rejectedWhen HR rejects a loan applicationThe employee

Other​

TriggerWhenWho receives it
Announcement Published announcement_publishedWhen an announcement with "Send email notification" switched on is published, or, for a scheduled one, when its publish time arrives. Each announcement is emailed onceEvery employee in the announcement's audience
Birthday Wish birthday_wishDaily at 9:00 workspace time, on the person's birthday (28 February for a 29 February birthday outside leap years)The employee; a former employee receives it at their personal address only

Attendance​

TriggerWhenWho receives it
Overtime Request (to Manager) overtime_requestedWhen an employee submits an overtime request that needs approvalThe employee's reporting manager; with no usable manager, every active user holding both attendance.overtime_approve and attendance.view_all
Overtime Approved overtime_approvedWhen an approver approves an overtime request, or when the request is approved automatically on submission because auto-approve is onThe employee
Overtime Rejected overtime_rejectedWhen an approver rejects an overtime requestThe employee
Attendance Regularization Request (to Manager) regularization_requestedWhen an employee requests a correction to a day's attendanceThe employee's reporting manager; with no usable manager, every active user holding both attendance.regularize_approve and attendance.view_all
Attendance Regularization Approved regularization_approvedWhen an approver approves the correctionThe employee
Attendance Regularization Rejected regularization_rejectedWhen an approver rejects the correctionThe employee
Missing Check-In Reminder attendance_missing_clockin_reminderChecked every 15 minutes; sent once per shift when there is no check-in by shift start plus the reminder offset (60 minutes by default). Only when missing-punch reminders are on; never on a weekly off, a holiday, approved leave, or a shift that does not require punchesThe employee
Missing Check-Out Reminder attendance_missing_clockout_reminderAs above, when there is no check-out by shift end plus the reminder offsetThe employee

Address Verification​

TriggerWhenWho receives it
Address Verification Initiated address_verification_initiatedWhen an employee asks for an address to be verified, or HR starts a verification for an unverified addressThe employee
Address Verification Reminder (Day 7) address_verification_reminder_7Daily job, shortly after 9:00 workspace time, on the 7th calendar day after verification was requested, while it is still pending. Not sent when the workspace has switched address verification off, or to employees who are not activeThe employee
Address Verification Reminder (Day 14) address_verification_reminder_14As above, on day 14The employee
Address Verification Urgent (Day 21) address_verification_reminder_21As above, on day 21The employee
Address Verification Final Warning (Day 28) address_verification_finalAs above, on day 28The employee

Documents​

TriggerWhenWho receives it
Document Uploaded (to HR) document_uploadedWhen a document is uploaded to an employee's profile, by the employee or by HR, while document verification is switched onActive users holding documents.verify, except the employee the document belongs to
Document Verified document_verifiedWhen a reviewer verifies the documentThe employee
Document Rejected document_rejectedWhen a reviewer rejects the document, or revokes an earlier verificationThe employee

Workspace​

Rows marked "sent by the platform; cannot be switched off" are also sent while the workspace is read-only, when every other trigger in this appendix is held back, and a workspace cannot edit their wording. "Billing contacts" means the active users holding company.settings; when nobody holds it, the oldest active user.

TriggerWhenWho receives it
Workspace Invitation workspace_invitationWhen an admin adds a user who is not linked to an employee and chooses to invite them, or sends or re-sends that invitationThe invited email address
Trial Ending Soon trial_ending_soonDaily job, 7 days and again 1 day before a trial ends, for a trial with no card on file. Sent by the platform; cannot be switched offBilling contacts
Trial Ended — Workspace Read-only trial_expiredDaily job, once, after the trial has ended and the workspace has become read-only. Sent by the platform; cannot be switched offBilling contacts
Subscription Canceled — Workspace Read-only subscription_canceledDaily job, once, after a canceled subscription has made the workspace read-only. Sent by the platform; cannot be switched offBilling contacts
Workspace Data Deletion Warning workspace_retention_warningDaily job, 14 days and again 3 days before a read-only workspace's data is due for deletion. Sent by the platform; cannot be switched offBilling contacts
Workspace Data Deleted workspace_data_purgedOnce, right after the platform deletes a read-only workspace at the end of the retention period (automatic deletion runs only when the platform operator has switched it on). Sent by the platform; cannot be switched offBilling contacts, as they were just before the deletion
Workspace Reactivated subscription_reactivatedWhen a checkout is completed for a workspace that was read-only. Sent by the platform; cannot be switched offBilling contacts
Seat Change Not Completed seat_change_payment_failedWhen a requested change in the number of seats expires without being paid. Sent by the platform; cannot be switched offBilling contacts
Keep Your Personal Profile personal_account_offerRight after a workspace is deleted, once for each person whose profile was set aside. Sent by the platform; cannot be switched offThat person, at their personal email address (people with no personal address are not offered one)

HR Letters​

TriggerWhenWho receives it
HR Letter Issued hr_letter_issuedWhen HR emails an issued letter, or issues a letter that fulfils an employee's letter request. The letter PDF is attached. Letters issued automatically by other modules are not emailed through this triggerThe employee
HR Letter Request — Submitted hr_letter_request_createdWhen an employee requests a letterActive users holding hr_letters.manage_requests
HR Letter Request — Rejected hr_letter_request_rejectedWhen HR rejects a letter requestThe employee

Appraisals​

TriggerWhenWho receives it
Appraisal Cycle Started — Self Review appraisal_cycle_startedWhen HR rolls out an appraisal cycle, only when self reviews are switched on, and only to employees that rollout newly addsEach newly added employee
Self Review Submitted — Manager Notification appraisal_self_review_submittedWhen an employee submits their self review, or when HR assigns a new reviewer to an appraisal whose self review is already doneThe appraisal's reviewer (set to the employee's reporting manager at rollout)
Manager Review Submitted — HR Notification appraisal_manager_review_submittedWhen the reviewer submits their manager reviewActive users holding appraisals.manage
Appraisal Finalized — Employee Notification appraisal_finalizedWhen HR finalises the appraisal. The appraisal PDF is attached when it rendersThe employee

Assets​

TriggerWhenWho receives it
Asset Issued — Employee Notification asset_issuedWhen an asset is issued to an employeeThat employee
Asset Returned — Employee Confirmation asset_returnedWhen an asset an employee was holding is checked back inThe employee who held it
Asset Overdue Return — Reminder asset_overdue_returnDaily, from 9:00 workspace time, for each asset still out past its expected return dateThe active employee holding it
Asset Handover Daily Digest — HR asset_handover_summaryDaily, from 18:00 workspace time, when at least one asset was issued or returned since 18:00 the day beforeActive users holding assets.manage

Offboarding​

TriggerWhenWho receives it
Separation Initiated separation_initiatedWhen HR starts a separation in OffboardingThe employee, at both work and personal addresses; and, as a separate copy that also carries HR's internal reason, active users holding offboarding.manage
Separation Clearance Completed — HR separation_clearance_completedWhen the last item on the clearance checklist is completedActive users holding offboarding.manage
Final Settlement Paid — Employee separation_final_settlement_paidWhen HR completes the final settlement. The experience letter PDF is attached when one was issuedThe ex-employee, at both work and personal addresses
Account Closing Soon — Ex-Employee Warning offboarding_account_closing_soonDaily job, shortly after 10:00 workspace time, 5 days before the ex-employee's portal account closes (the account closes after the post-settlement grace period, 30 days by default)The ex-employee, at both work and personal addresses
Account Closed — Final Notice offboarding_account_closedSame daily job, when the grace period ends and the ex-employee's active portal account is closedThe ex-employee, at both work and personal addresses

Onboarding​

TriggerWhenWho receives it
Pre-Joining Welcome Email pre_joining_emailWhen HR clicks Run on the "Send pre-joining email" task of the onboarding checklist (the task is due 7 days before joining)The new employee
Onboarding Pipeline Started — HR onboarding_startedWhen a new employee is added and their onboarding checklist is createdActive users holding onboarding.manage
Onboarding Task Assigned onboarding_task_assignedWhen a checklist task is assigned, or reassigned, to a userThe user the task is assigned to
Onboarding Completed — Employee onboarding_completedWhen every required checklist task is completed or waivedThe employee
Probation Ending Reminder — HR probation_ending_reminderDaily digest at 9:15 workspace time, whenever at least one active, unconfirmed employee's probation ends within 14 days or has already endedActive users holding employees.confirm
Employee Confirmed (Probation Complete) employee_confirmedWhen HR confirms an employee after probation. The confirmation letter PDF is attached when one is issuedThe employee

Expenses​

TriggerWhenWho receives it
Expense Claim Submitted expense_claim_submittedWhen an employee submits an expense claimThe employee's reporting manager (when they have an email address) and active users holding expenses.manage
Expense Claim Manager-Approved — HR expense_claim_manager_approvedWhen the reporting manager approves the claimActive users holding expenses.manage
Expense Claim Approved — Employee expense_claim_approvedWhen HR gives final approval and the reimbursement is added to payrollThe employee
Expense Claim Rejected — Employee expense_claim_rejectedWhen the reporting manager or HR rejects the claimThe employee

Recruitment​

TriggerWhenWho receives it
Application Received — Candidate Confirmation application_receivedWhen a candidate applies on the careers site, or HR adds an application by handThe candidate
Interview Scheduled — Candidate Invitation interview_scheduledWhen HR schedules an interview. A calendar invitation is attachedThe candidate
Interview Invited — Interviewer interview_invited_interviewerWhen HR schedules an interviewEach interview panel member, one email each
Interview Confirmed by Candidate — Interviewer interview_candidate_confirmedWhen the candidate confirms the interview from their linkEach interview panel member
Reschedule Requested by Candidate — Interviewer interview_reschedule_requestedWhen the candidate asks to reschedule from their linkEach interview panel member
Interview Reminder — Candidate (24h before) interview_reminder_candidateHourly job, once, about 24 hours before a scheduled interview. A calendar invitation is attachedThe candidate
Interview Reminder — Interviewer (24h before) interview_reminder_interviewerHourly job, once, about 24 hours before a scheduled interviewEach interview panel member
Offer Extended — Candidate offer_extendedWhen HR extends an offer. The offer letter PDF is attached when it rendersThe candidate
Offer Accepted — Hiring Team offer_accepted_by_candidateWhen the candidate accepts the offer from their linkThe job's hiring manager and the user who extended the offer
Offer Declined — Hiring Team offer_declined_by_candidateWhen the candidate declines the offer from their linkThe job's hiring manager and the user who extended the offer
Application Rejected — Candidate application_rejectedWhen HR moves an application to the Rejected stageThe candidate

Performance​

TriggerWhenWho receives it
Performance Task Assigned — Employee performance_task_assignedWhen a manager confirms a one-off task's weight and the task becomes assigned, or when a recurring task schedule creates the day's taskThe task's assignee
Performance Task Overdue — Employee performance_task_overdueHourly job, once, when an open task passes its due timeThe task's assignee
Performance Task Reminder — Employee performance_task_reminderHourly job, before a one-off task's due time, once at each reminder offset set in Performance settings (24 and 6 hours before by default)The task's assignee
Performance Task Submitted — Manager performance_task_submittedWhen the assignee marks a manager-graded task completeThe assignee's reporting manager
Performance Task Graded — Employee performance_task_gradedWhen a manager grades a task, or when a rule-graded task is completed and scored automaticallyThe task's assignee
Daily Report Missed — Employee performance_daily_report_missedHourly job, once the employee's shift has ended plus one hour on a working day with no daily report. Only when daily reports are switched on and the employee is not exemptThe employee
Daily Report Submitted — Manager/Admin performance_daily_report_submittedWhen an employee submits their daily reportThe employee's reporting manager, and the extra report recipient set in Performance settings, if any
Weekly Sales Report Reminder — Employee sales_report_reminderOn the weekly sales report due day, at the reminder hour set in Performance settings, when that week's report is not in yetEach active employee in a department whose name contains "sales"
Weekly Sales Report Missed — Employee sales_report_missedHourly job, once the week's deadline has passed with no reportThe sales staff member who missed it
Weekly Sales Report Submitted — Manager/Admin sales_report_submittedWhen a sales staff member submits their weekly reportTheir reporting manager, and the extra report recipient set in Performance settings, if any

Field Visits​

TriggerWhenWho receives it
Visit Feedback — Client Confirmation Request visit_feedbackAfter a field rep checks out of a client visit, when feedback by email is switched on in the field visit settings. At most one request per client in any 24 hours, and never to a client who opted outThe client's contact email

Not listed​

  • Partner Programme (the seven affiliate_* triggers): mail between the platform and its partners; no workspace sends or receives it, so the Email Templates screen does not show it.
  • Appointment Letter appointment_letter and Confirmation Letter confirmation_letter: nothing sends these triggers. An issued letter reaches the employee through HR Letter Issued when HR emails it, and the confirmation through Employee Confirmed.
  • Separation Clearance separation_clearance: predates the Offboarding module and nothing sends it; Offboarding sends Separation Initiated and Separation Clearance Completed instead.