@react-email/components, rendered to HTML server-side, and sent via Resend. Pass the template name as the template field in POST /api/v1/email.
Brand colours used across all templates:
User Onboarding & Auth
verify — Email OTP verification
verify — Email OTP verification
Sends a 6-digit OTP for email address verification.Template name:
verifyRequired data fields:Subject:
"Verify your email address"verify-email-link — Link-based email verification
verify-email-link — Link-based email verification
Sends a clickable verification link instead of an OTP code.Template name:
verify-email-linkRequired data fields:reset — Password reset
reset — Password reset
Sends a password reset link.Template name:
resetRequired data fields:Subject:
"Reset your password"invite — Team invitation
invite — Team invitation
Invites a new user to join an organisation.Template name:
inviteRequired data fields:transfer-site — Site transfer notification
transfer-site — Site transfer notification
Notifies a user that a website has been transferred to their account.Template name:
transfer-siteRequired data fields:Report Emails
report — Standard report ready
report — Standard report ready
Notifies the user that their audit report is ready for download.Template name:
reportRequired data fields:Subject:
"Your audit report is ready"report-full — Full suite report
report-full — Full suite report
Full suite report email with all metric scores.Template name:
report-fullRequired data fields:report-agency — Agency lead notification
report-agency — Agency lead notification
Sent to the
agencyEmail when a report is generated with an agency partner attached.Template name: report-agencyRequired data fields:report-primary — Primary metric report
report-primary — Primary metric report
Single-metric focused report email.Template name:
report-primaryTrial Lifecycle
These emails are sent automatically during the trial period progression.
Required
data fields (all trial emails):
Billing & Credits
purchase-success — Purchase confirmation
purchase-success — Purchase confirmation
Sent after a successful subscription payment.Template name:
purchase-successcredit-reset — Monthly credit reset
credit-reset — Monthly credit reset
Notifies the user that their scan credits have been reset for the new billing cycle.Template name:
credit-resetlow-credit — Low credit warning
low-credit — Low credit warning
Alert when the organisation’s scan credits fall below a threshold.Template name:
low-creditagency-coupon — Agency coupon code
agency-coupon — Agency coupon code
Sends a generated Stripe promotion code to an agency partner. Triggered via
POST /api/v1/embed.Template name: agency-couponUptime Monitoring
site-down — Website down alert
site-down — Website down alert
Sent immediately when an uptime monitor detects a website is unreachable.Template name:
site-downsite-up — Website recovered
site-up — Website recovered
Sent when the uptime monitor confirms a previously down website is accessible again.Template name:
site-upScan Lifecycle
Required
data fields: