Search…
⌃K
Links

Custom HTML for Emails

Seamlessly integrate your brand into Passage with full HTML email templates.
Passage allows you to create your own customized emails to match your brand and build trust with your user base. Upload HTML directly into the Passage Console and use the template variables to build a delightful experience for login and verification emails.
This page provides step-by-step instructions for configuring your HTML templates in Passage.

Create a template

Email templates can be updated in the Branding section of the Passage Console.
For each email type, the subject and email body can be customized. Both the subject and email body have access to template variables that can be used to further customize your email.

Build and test your template

Once you have your subject and HTML saved we can go ahead and verify what users will receive. By clicking the Test Email button you will kick off an email with your new configuration to the email associated with your Passage Console user. Note: Saving changes to your template or subject will not enable the custom template.

Enable your template

Once you've setup and tested your new email it's time to let Passage know to send your custom option for this email type. You can do this by moving the Enabled toggle to On and pressing the Save button.
You are now sending custom emails!
Note: Enabling an email configuration is per email type - use the tab under Email Templates in the UI to switch email types.

Email Templates

Passage supports only one template for each email type. The emails currently sent from Passage are:
This email is sent when a user initiates an email change from their profile. The full set of template variables that are available is listed below, but you must includes the {{.magic_link.url}} which is the link that enables the user to verify and complete their email change.

Template Variables

App object variables:
  • {{.app.id}}
  • {{.app.name}}
  • {{.app.auth_origin}}
  • {{.app.login_url}}
Magic_link object variables:
  • {{.magic_link.url}}
  • {{.magic_link.ttl}}
  • {{.magic_link.locale}}
User object variables:
  • {{.user.id}}
  • {{.user.email}}
  • {{.user.phone}}
  • {{.user.status}}
  • {{.user.email_verified}}
  • {{.user.user_metadata.<field_name>}}
    • For more information regarding user metadata fields navigate here.

FAQ

  • Q: What happens if a user has no value for a meta data field I am using in my template?
    • A: An empty string will be inputted into the template and the email will still be sent successfully.